From 3c366dc87aefef8d6c0e86fa3f194e724497c5d8 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Sat, 25 Oct 2025 20:33:44 +0900 Subject: [PATCH] docs(i18n): new Crowdin updates (#6716) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Japanese) * New translations readme.md (Ukrainian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Ukrainian) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Ukrainian) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations tokyo-night.md (Chinese Traditional) * New translations gruvbox-rainbow.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations bracketed-segments.md (Chinese Traditional) * New translations nerd-font.md (Chinese Traditional) * New translations no-runtimes.md (Chinese Traditional) * New translations plain-text.md (Chinese Traditional) * New translations pure-preset.md (Chinese Traditional) * New translations pastel-powerline.md (Chinese Traditional) * New translations no-nerd-font.md (Chinese Traditional) * New translations no-empty-icons.md (Chinese Traditional) * New translations gruvbox-rainbow.md (Chinese Traditional) * New translations jetpack.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Portuguese, Brazilian) * New translations jetpack.md (Portuguese, Brazilian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (French) * New translations pure-preset.md (French) * New translations tokyo-night.md (French) * New translations readme.md (Spanish) * New translations pure-preset.md (Spanish) * New translations tokyo-night.md (Spanish) * New translations readme.md (Arabic) * New translations pure-preset.md (Arabic) * New translations tokyo-night.md (Arabic) * New translations readme.md (German) * New translations pure-preset.md (German) * New translations tokyo-night.md (German) * New translations readme.md (Italian) * New translations pure-preset.md (Italian) * New translations tokyo-night.md (Italian) * New translations readme.md (Japanese) * New translations pure-preset.md (Japanese) * New translations tokyo-night.md (Japanese) * New translations readme.md (Korean) * New translations pure-preset.md (Korean) * New translations tokyo-night.md (Korean) * New translations readme.md (Dutch) * New translations pure-preset.md (Dutch) * New translations tokyo-night.md (Dutch) * New translations readme.md (Norwegian) * New translations pure-preset.md (Norwegian) * New translations tokyo-night.md (Norwegian) * New translations readme.md (Polish) * New translations pure-preset.md (Polish) * New translations tokyo-night.md (Polish) * New translations readme.md (Portuguese) * New translations pure-preset.md (Portuguese) * New translations tokyo-night.md (Portuguese) * New translations readme.md (Russian) * New translations pure-preset.md (Russian) * New translations tokyo-night.md (Russian) * New translations readme.md (Turkish) * New translations pure-preset.md (Turkish) * New translations tokyo-night.md (Turkish) * New translations readme.md (Ukrainian) * New translations pure-preset.md (Ukrainian) * New translations tokyo-night.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations pure-preset.md (Chinese Simplified) * New translations tokyo-night.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations pure-preset.md (Chinese Traditional) * New translations tokyo-night.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations pure-preset.md (Vietnamese) * New translations tokyo-night.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations pure-preset.md (Portuguese, Brazilian) * New translations tokyo-night.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations pure-preset.md (Indonesian) * New translations tokyo-night.md (Indonesian) * New translations readme.md (Bengali) * New translations pure-preset.md (Bengali) * New translations tokyo-night.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations pure-preset.md (Sorani (Kurdish)) * New translations tokyo-night.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (Japanese) * New translations readme.md (Norwegian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (French) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations catppuccin-powerline.md (Korean) --- docs/ar-SA/README.md | 15 +- docs/ar-SA/advanced-config/README.md | 6 +- docs/ar-SA/config/README.md | 440 ++-- docs/ar-SA/guide/README.md | 9 +- docs/ar-SA/presets/README.md | 6 +- docs/ar-SA/presets/catppuccin-powerline.md | 4 +- docs/ar-SA/presets/pure-preset.md | 2 +- docs/ar-SA/presets/tokyo-night.md | 2 +- docs/bn-BD/README.md | 15 +- docs/bn-BD/advanced-config/README.md | 6 +- docs/bn-BD/config/README.md | 440 ++-- docs/bn-BD/guide/README.md | 9 +- docs/bn-BD/presets/README.md | 6 +- docs/bn-BD/presets/catppuccin-powerline.md | 4 +- docs/bn-BD/presets/pure-preset.md | 2 +- docs/bn-BD/presets/tokyo-night.md | 2 +- docs/ckb-IR/README.md | 15 +- docs/ckb-IR/advanced-config/README.md | 6 +- docs/ckb-IR/config/README.md | 440 ++-- docs/ckb-IR/guide/README.md | 9 +- docs/ckb-IR/presets/README.md | 6 +- docs/ckb-IR/presets/catppuccin-powerline.md | 4 +- docs/ckb-IR/presets/pure-preset.md | 2 +- docs/ckb-IR/presets/tokyo-night.md | 2 +- docs/de-DE/README.md | 15 +- docs/de-DE/advanced-config/README.md | 6 +- docs/de-DE/config/README.md | 442 ++-- docs/de-DE/faq/README.md | 20 +- docs/de-DE/guide/README.md | 9 +- docs/de-DE/presets/README.md | 6 +- docs/de-DE/presets/catppuccin-powerline.md | 4 +- docs/de-DE/presets/pure-preset.md | 2 +- docs/de-DE/presets/tokyo-night.md | 2 +- docs/es-ES/README.md | 17 +- docs/es-ES/advanced-config/README.md | 26 +- docs/es-ES/config/README.md | 474 ++--- docs/es-ES/guide/README.md | 56 +- docs/es-ES/presets/README.md | 6 +- docs/es-ES/presets/catppuccin-powerline.md | 4 +- docs/es-ES/presets/pure-preset.md | 2 +- docs/es-ES/presets/tokyo-night.md | 2 +- docs/fr-FR/README.md | 23 +- docs/fr-FR/advanced-config/README.md | 6 +- docs/fr-FR/config/README.md | 432 ++-- docs/fr-FR/faq/README.md | 14 +- docs/fr-FR/guide/README.md | 19 +- docs/fr-FR/presets/README.md | 6 +- docs/fr-FR/presets/catppuccin-powerline.md | 4 +- docs/fr-FR/presets/pure-preset.md | 2 +- docs/fr-FR/presets/tokyo-night.md | 2 +- docs/id-ID/README.md | 15 +- docs/id-ID/advanced-config/README.md | 6 +- docs/id-ID/config/README.md | 450 ++-- docs/id-ID/guide/README.md | 9 +- docs/id-ID/presets/README.md | 6 +- docs/id-ID/presets/catppuccin-powerline.md | 4 +- docs/id-ID/presets/pure-preset.md | 2 +- docs/id-ID/presets/tokyo-night.md | 2 +- docs/it-IT/README.md | 15 +- docs/it-IT/advanced-config/README.md | 6 +- docs/it-IT/config/README.md | 440 ++-- docs/it-IT/guide/README.md | 9 +- docs/it-IT/presets/README.md | 6 +- docs/it-IT/presets/catppuccin-powerline.md | 4 +- docs/it-IT/presets/pure-preset.md | 2 +- docs/it-IT/presets/tokyo-night.md | 2 +- docs/ja-JP/README.md | 15 +- docs/ja-JP/advanced-config/README.md | 8 +- docs/ja-JP/config/README.md | 500 ++--- docs/ja-JP/guide/README.md | 9 +- docs/ja-JP/presets/README.md | 6 +- docs/ja-JP/presets/catppuccin-powerline.md | 2 +- docs/ja-JP/presets/pure-preset.md | 2 +- docs/ja-JP/presets/tokyo-night.md | 2 +- docs/ko-KR/README.md | 15 +- docs/ko-KR/advanced-config/README.md | 6 +- docs/ko-KR/config/README.md | 454 ++-- docs/ko-KR/faq/README.md | 61 +- docs/ko-KR/guide/README.md | 9 +- docs/ko-KR/installing/README.md | 20 +- docs/ko-KR/migrating-to-0.45.0/README.md | 164 +- docs/ko-KR/presets/README.md | 6 +- docs/ko-KR/presets/catppuccin-powerline.md | 16 +- docs/ko-KR/presets/pure-preset.md | 2 +- docs/ko-KR/presets/tokyo-night.md | 2 +- docs/nl-NL/README.md | 15 +- docs/nl-NL/advanced-config/README.md | 6 +- docs/nl-NL/config/README.md | 452 ++-- docs/nl-NL/guide/README.md | 9 +- docs/nl-NL/presets/README.md | 6 +- docs/nl-NL/presets/catppuccin-powerline.md | 4 +- docs/nl-NL/presets/pure-preset.md | 2 +- docs/nl-NL/presets/tokyo-night.md | 2 +- docs/no-NO/README.md | 15 +- docs/no-NO/advanced-config/README.md | 6 +- docs/no-NO/config/README.md | 440 ++-- docs/no-NO/guide/README.md | 9 +- docs/no-NO/presets/README.md | 6 +- docs/no-NO/presets/catppuccin-powerline.md | 4 +- docs/no-NO/presets/pure-preset.md | 2 +- docs/no-NO/presets/tokyo-night.md | 2 +- docs/pl-PL/README.md | 15 +- docs/pl-PL/advanced-config/README.md | 6 +- docs/pl-PL/config/README.md | 440 ++-- docs/pl-PL/guide/README.md | 9 +- docs/pl-PL/presets/README.md | 6 +- docs/pl-PL/presets/catppuccin-powerline.md | 4 +- docs/pl-PL/presets/pure-preset.md | 2 +- docs/pl-PL/presets/tokyo-night.md | 2 +- docs/pt-BR/README.md | 15 +- docs/pt-BR/advanced-config/README.md | 6 +- docs/pt-BR/config/README.md | 450 ++-- docs/pt-BR/guide/README.md | 11 +- docs/pt-BR/presets/README.md | 8 +- docs/pt-BR/presets/catppuccin-powerline.md | 4 +- docs/pt-BR/presets/jetpack.md | 2 +- docs/pt-BR/presets/pure-preset.md | 2 +- docs/pt-BR/presets/tokyo-night.md | 2 +- docs/pt-PT/README.md | 15 +- docs/pt-PT/advanced-config/README.md | 6 +- docs/pt-PT/config/README.md | 440 ++-- docs/pt-PT/guide/README.md | 9 +- docs/pt-PT/presets/README.md | 6 +- docs/pt-PT/presets/catppuccin-powerline.md | 4 +- docs/pt-PT/presets/pure-preset.md | 2 +- docs/pt-PT/presets/tokyo-night.md | 2 +- docs/ru-RU/README.md | 15 +- docs/ru-RU/advanced-config/README.md | 6 +- docs/ru-RU/config/README.md | 442 ++-- docs/ru-RU/guide/README.md | 9 +- docs/ru-RU/presets/README.md | 6 +- docs/ru-RU/presets/catppuccin-powerline.md | 4 +- docs/ru-RU/presets/pure-preset.md | 2 +- docs/ru-RU/presets/tokyo-night.md | 2 +- docs/tr-TR/README.md | 15 +- docs/tr-TR/advanced-config/README.md | 6 +- docs/tr-TR/config/README.md | 440 ++-- docs/tr-TR/faq/README.md | 18 +- docs/tr-TR/guide/README.md | 9 +- docs/tr-TR/presets/README.md | 6 +- docs/tr-TR/presets/catppuccin-powerline.md | 4 +- docs/tr-TR/presets/pure-preset.md | 2 +- docs/tr-TR/presets/tokyo-night.md | 2 +- docs/uk-UA/README.md | 15 +- docs/uk-UA/advanced-config/README.md | 6 +- docs/uk-UA/config/README.md | 508 ++--- docs/uk-UA/guide/README.md | 9 +- docs/uk-UA/presets/README.md | 6 +- docs/uk-UA/presets/catppuccin-powerline.md | 4 +- docs/uk-UA/presets/pure-preset.md | 2 +- docs/uk-UA/presets/tokyo-night.md | 2 +- docs/vi-VN/README.md | 15 +- docs/vi-VN/advanced-config/README.md | 6 +- docs/vi-VN/config/README.md | 444 ++-- docs/vi-VN/guide/README.md | 9 +- docs/vi-VN/presets/README.md | 6 +- docs/vi-VN/presets/catppuccin-powerline.md | 4 +- docs/vi-VN/presets/pure-preset.md | 2 +- docs/vi-VN/presets/tokyo-night.md | 2 +- docs/zh-CN/README.md | 15 +- docs/zh-CN/advanced-config/README.md | 8 +- docs/zh-CN/config/README.md | 440 ++-- docs/zh-CN/guide/README.md | 9 +- docs/zh-CN/presets/README.md | 6 +- docs/zh-CN/presets/catppuccin-powerline.md | 4 +- docs/zh-CN/presets/pure-preset.md | 2 +- docs/zh-CN/presets/tokyo-night.md | 2 +- docs/zh-TW/README.md | 15 +- docs/zh-TW/advanced-config/README.md | 12 +- docs/zh-TW/config/README.md | 2052 ++++++++++--------- docs/zh-TW/guide/README.md | 17 +- docs/zh-TW/presets/README.md | 6 +- docs/zh-TW/presets/bracketed-segments.md | 2 +- docs/zh-TW/presets/catppuccin-powerline.md | 4 +- docs/zh-TW/presets/gruvbox-rainbow.md | 4 +- docs/zh-TW/presets/jetpack.md | 2 +- docs/zh-TW/presets/nerd-font.md | 2 +- docs/zh-TW/presets/no-empty-icons.md | 2 +- docs/zh-TW/presets/no-nerd-font.md | 2 +- docs/zh-TW/presets/no-runtimes.md | 2 +- docs/zh-TW/presets/pastel-powerline.md | 2 +- docs/zh-TW/presets/plain-text.md | 2 +- docs/zh-TW/presets/pure-preset.md | 4 +- docs/zh-TW/presets/tokyo-night.md | 6 +- 184 files changed, 6256 insertions(+), 6172 deletions(-) diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index fcd60b706..9536248f9 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - أضف ما يلي إلى نهاية الملف `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/ar-SA/advanced-config/README.md b/docs/ar-SA/advanced-config/README.md index cfe30d40b..7a4bd3bc5 100644 --- a/docs/ar-SA/advanced-config/README.md +++ b/docs/ar-SA/advanced-config/README.md @@ -2,11 +2,7 @@ While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. -::: تحذير - -The configurations in this section are subject to change in future releases of Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index ea0799fdb..d44af99ad 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### مثال @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Variable | الافتراضي | الوصف | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### مثال @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### مثال @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). -::: تحذير - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | الافتراضي | الوصف | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | الافتراضي | الوصف | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | مثال | الوصف | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: تحذير +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: تحذير - -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. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### مثال +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: تحذير - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | الافتراضي | الوصف | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | الافتراضي | الوصف | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | مثال | الوصف | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | الافتراضي | الوصف | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: تحذير +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | الافتراضي | الوصف | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | الافتراضي | الوصف | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | مثال | الوصف | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index 1250b8202..87af441c9 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS +7 | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora +40 | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -أضف ما يلي إلى نهاية الملف `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -ملاحظة: فقط +Elvish v0.18 مدعوم +ملاحظة: فقط +Elvish v0.18 مدعوم. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ If you're looking to further customize Starship: ## 🤝 المساهمة -نبحث دائماً عن مساهمين من **جميع المستويات**! إذا كنت تتطلع إلى تسهيل طريقك إلى المشروع، جرب [إنشاء اول مشكلة](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +نبحث دائماً عن مساهمين من **جميع المستويات**! 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/). diff --git a/docs/ar-SA/presets/README.md b/docs/ar-SA/presets/README.md index 1a6862a11..72def9078 100644 --- a/docs/ar-SA/presets/README.md +++ b/docs/ar-SA/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/ar-SA/presets/catppuccin-powerline.md b/docs/ar-SA/presets/catppuccin-powerline.md index 7a4715e2a..356cd981a 100644 --- a/docs/ar-SA/presets/catppuccin-powerline.md +++ b/docs/ar-SA/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/ar-SA/presets/pure-preset.md b/docs/ar-SA/presets/pure-preset.md index b27468de9..d4dc71508 100644 --- a/docs/ar-SA/presets/pure-preset.md +++ b/docs/ar-SA/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/ar-SA/presets/tokyo-night.md b/docs/ar-SA/presets/tokyo-night.md index 398b3c787..46ee916f3 100644 --- a/docs/ar-SA/presets/tokyo-night.md +++ b/docs/ar-SA/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/bn-BD/README.md b/docs/bn-BD/README.md index c160b0910..53d5e708a 100644 --- a/docs/bn-BD/README.md +++ b/docs/bn-BD/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - `~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/bn-BD/advanced-config/README.md b/docs/bn-BD/advanced-config/README.md index 678593e33..13e2c7d84 100644 --- a/docs/bn-BD/advanced-config/README.md +++ b/docs/bn-BD/advanced-config/README.md @@ -2,11 +2,7 @@ While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. -::: warning - -The configurations in this section are subject to change in future releases of Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/bn-BD/config/README.md b/docs/bn-BD/config/README.md index 08c43de73..6d6d05f20 100644 --- a/docs/bn-BD/config/README.md +++ b/docs/bn-BD/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Variable | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Example +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Example | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Example diff --git a/docs/bn-BD/guide/README.md b/docs/bn-BD/guide/README.md index a011e9c38..976ec2eaf 100644 --- a/docs/bn-BD/guide/README.md +++ b/docs/bn-BD/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -`~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -বিঃদ্রঃ শুধুমাত্র Elvish v0.18+ কাজ করবে । +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ eval "$(starship init zsh)" ## 🤝 নিজে অবদান রাখুন -আমরা সবসময় **সকল দক্ষতা স্তরের** অবদানকারীদের খুঁজছি! আপনি যদি সহজ ভাবে এই প্রোজেক্টে অবদান রাখতে চান তাইলে ["good first issue"](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) গুলির সমাধান করার চেষ্টা করতে পারেন । +আমরা সবসময় **সকল দক্ষতা স্তরের** অবদানকারীদের খুঁজছি! 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/) পেইজ এ গিয়ে আপনার অনুবাদ গুলি যোগ করতে পারবেন । diff --git a/docs/bn-BD/presets/README.md b/docs/bn-BD/presets/README.md index 1a6862a11..72def9078 100644 --- a/docs/bn-BD/presets/README.md +++ b/docs/bn-BD/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/bn-BD/presets/catppuccin-powerline.md b/docs/bn-BD/presets/catppuccin-powerline.md index 6609eea15..086cb8d1e 100644 --- a/docs/bn-BD/presets/catppuccin-powerline.md +++ b/docs/bn-BD/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/bn-BD/presets/pure-preset.md b/docs/bn-BD/presets/pure-preset.md index b27468de9..d4dc71508 100644 --- a/docs/bn-BD/presets/pure-preset.md +++ b/docs/bn-BD/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/bn-BD/presets/tokyo-night.md b/docs/bn-BD/presets/tokyo-night.md index 59d8f2ca2..c5600ec58 100644 --- a/docs/bn-BD/presets/tokyo-night.md +++ b/docs/bn-BD/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/ckb-IR/README.md b/docs/ckb-IR/README.md index fffaa7b26..284118858 100644 --- a/docs/ckb-IR/README.md +++ b/docs/ckb-IR/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/ckb-IR/advanced-config/README.md b/docs/ckb-IR/advanced-config/README.md index 2cbde3f2b..4b7a58622 100644 --- a/docs/ckb-IR/advanced-config/README.md +++ b/docs/ckb-IR/advanced-config/README.md @@ -2,11 +2,7 @@ لەگەڵ ئەوەی Starship شێڵێکە بەکارهێنانی زۆرە، هەندێک جار دەسکاری کردنی `starship.toml` بەس نییە بۆ ئەوەی وای لێبکەی هەندێک شتی دیاریکراو ئەنجام بدات. ئەم پەڕەیە ووردەکاری زیاتر ئەدات لەسەر هەندێک لە شێوازە ڕێکخستنە پێشکەوتووترەکان کە لە Starshipـدا بەکارهاتووە. -::: ئاگادارکردنەوە - -ڕێکخستنەکانی ئەم بەشە شایەنی گۆڕانن لە وەشانەکانی داهاتووی Starshipدا. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index 185641358..bcfbc9645 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### نموونە @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | گۆڕاو | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### نموونە @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### نموونە @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). -::: ئاگادارکردنەوە - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: ئاگادارکردنەوە +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: ئاگادارکردنەوە - -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. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### نموونە +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: ئاگادارکردنەوە - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: ئاگادارکردنەوە +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index 170c762cf..a5cbcb279 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -226,9 +226,10 @@ Alternatively, install Starship using any of the following package managers: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -301,13 +302,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -403,7 +404,7 @@ If you're looking to further customize Starship: ## 🤝 بەژداریکردن -ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! ئەگەر بەدوای ئەوەوەی کە بێیتە ئەم پڕۆژەیەوە [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) تاقیبکەرەوە. +ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! 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/). diff --git a/docs/ckb-IR/presets/README.md b/docs/ckb-IR/presets/README.md index eea3e6f77..0a2985530 100644 --- a/docs/ckb-IR/presets/README.md +++ b/docs/ckb-IR/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/ckb-IR/presets/catppuccin-powerline.md b/docs/ckb-IR/presets/catppuccin-powerline.md index 2b2840b62..7ed44cca4 100644 --- a/docs/ckb-IR/presets/catppuccin-powerline.md +++ b/docs/ckb-IR/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/ckb-IR/presets/pure-preset.md b/docs/ckb-IR/presets/pure-preset.md index 48f2bb3f1..5ccb66f39 100644 --- a/docs/ckb-IR/presets/pure-preset.md +++ b/docs/ckb-IR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/ckb-IR/presets/tokyo-night.md b/docs/ckb-IR/presets/tokyo-night.md index 8e4247acd..021f246ce 100644 --- a/docs/ckb-IR/presets/tokyo-night.md +++ b/docs/ckb-IR/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index 70ccb8afa..0a863b43f 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Es wird nur elvish v0.18 oder höher unterstützt. - - ::: - - Trage folgendes am Ende von `~/.config/fish/rc.elv` ein: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - Das wird sich in Zukunft ändern. Nur Nushell v0.96+ wird unterstützt. - - ::: + > [!WARNING] This will change in the future. Nur Nushell v0.96+ wird unterstützt. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/de-DE/advanced-config/README.md b/docs/de-DE/advanced-config/README.md index e30ba8234..f5ccf12a9 100644 --- a/docs/de-DE/advanced-config/README.md +++ b/docs/de-DE/advanced-config/README.md @@ -2,11 +2,7 @@ Auch wenn Starship eine vielseitige Shell ist, reichen manche Konfigurationen in der `starship.toml` nicht aus, um manche Sachen zu erreichen. Diese Seite beschreibt einige fortgeschrittene Konfigurationen für Starship. -::: warning - -Die hier beschriebenen Konfigurationen werden sich mit kommenden Updates von Starship verändern. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index d86006653..5c8d5f435 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -209,11 +209,7 @@ Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Beispiel @@ -268,6 +264,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -282,6 +279,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -443,6 +441,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Variable | Standartwert | Beschreibung | @@ -659,15 +659,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Spiegelt den Wert der Option `symbol` | | style | | Spiegelt den Wert der Option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Beispiel @@ -682,6 +680,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standardwert | Beschreibung | @@ -705,15 +705,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Spiegelt den Wert der Option `symbol` | | style | | Spiegelt den Wert der Option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Beispiel @@ -736,11 +734,7 @@ Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erz 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Optionen @@ -856,13 +850,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t 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 `cmd_duration` angezeigt wird. -::: warning Nicht die DEBUG-trap in der Bash hooken +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -Ist `bash` die Konsole der Wahl, dann nicht die `DEBUG`-trap nach der Ausführung von `eval $(starship init $0)` hooken, andernfalls **wird** dieses Modul unweigerlich untergehen. - -::: - -Bash 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). Definieren Sie einfach die Arrays `preexec_functions` und `precmd_functions` bevor sie `eval $(starship init $0)` ausführen, und fahren Sie dann wie gewohnt fort. ### Optionen @@ -900,11 +892,7 @@ 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. -::: 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. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Optionen @@ -1207,6 +1195,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -1252,16 +1242,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Optionen -| Option | Standartwert | Beschreibung | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | Das Format für das 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'` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Standartwert | Beschreibung | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | Das Format für das 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` | `['compose.yml', 'compose.yaml', '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'` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1427,26 +1417,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Optionen @@ -1597,10 +1578,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Optionen + +| Option | Standartwert | Beschreibung | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | Stil für dieses Modul. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | -------- | ------------------------------------- | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -1637,6 +1657,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -1760,6 +1782,7 @@ Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuelle | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Deaktiviert das `git_branch`-Modul. | ### Variables @@ -1867,11 +1890,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ### Optionen @@ -1909,11 +1928,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Optionen @@ -1926,7 +1941,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2393,17 +2408,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Optionen @@ -2429,7 +2436,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Beispiel +### Beispiele ```toml # ~/.config/starship.toml @@ -2440,6 +2447,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2531,21 +2546,13 @@ 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`. -::: tip - -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Optionen -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Standartwert | Beschreibung | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2667,6 +2674,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -2743,11 +2752,7 @@ Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist. -::: tip - -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ### Optionen @@ -2827,6 +2832,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -2860,10 +2867,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + +### Optionen + +| Option | Standartwert | Beschreibung | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | Stil für dieses Modul. | +| `format` | `'\([$state]($style)\) '` | Das Format für das Modul. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| ---------------- | ---------- | ------------------------------------ | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Spiegelt den Wert der Option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -3172,16 +3214,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Optionen -| Option | Standartwert | Beschreibung | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Standartwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3278,17 +3320,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ### Optionen @@ -3310,6 +3344,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3353,7 +3388,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3388,7 +3423,7 @@ Arch = "Arch is the best! " ## Paketversion -Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3404,6 +3439,7 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3525,6 +3561,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -3540,11 +3578,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Optionen @@ -3553,12 +3587,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 dem Umgebungsnamen angezeigt wird. | -| `style` | `'yellow bold' | Stil für dieses Modul. | +| `style` | `'yellow bold'` | Stil für dieses Modul. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3583,11 +3617,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3713,13 +3743,9 @@ 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` | Deaktiviert das `python`-Modul. | -::: 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. - -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. - -::: +> [!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. +> +> 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 @@ -4037,11 +4063,7 @@ symbol = '🌟 ' 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. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ### Optionen @@ -4089,6 +4111,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. + ### Optionen | Option | Standartwert | Beschreibung | @@ -4243,11 +4267,7 @@ format = '[$symbol$environment](dimmed blue) ' 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. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ### Optionen @@ -4306,11 +4326,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ### Optionen @@ -4392,13 +4408,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4407,16 +4419,17 @@ By default the module will be shown if any of the following conditions are met: ### Optionen -| Option | Standartwert | Beschreibung | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `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. | +| Option | Standartwert | Beschreibung | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `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. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4437,7 +4450,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4446,18 +4459,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## 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. -::: tip - -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. - -::: +> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ### Optionen @@ -4538,11 +4547,7 @@ Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezei - Die Variable `show_always` ist auf true gesetzt - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Optionen @@ -4685,6 +4690,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- Das aktuelle Verzeichnis enthält eine `xmake.lua`-Datei + +### Optionen + +| Option | Standartwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | -------- | ------------------------------------- | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: @@ -4735,31 +4769,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Optionen @@ -4809,17 +4829,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Beispiel diff --git a/docs/de-DE/faq/README.md b/docs/de-DE/faq/README.md index 354238f1f..78c1529d5 100644 --- a/docs/de-DE/faq/README.md +++ b/docs/de-DE/faq/README.md @@ -1,4 +1,4 @@ -# Frequently Asked Questions +# Häufig gestellte Fragen ## Wie ist die Konfiguration im Demo GIF? @@ -10,15 +10,15 @@ - **Konfiguration**: [Matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **Prompt**: [Starship](https://starship.rs/) -## How do I get command completion as shown in the demo GIF? +## Wie bekomme ich die Autovervollständigung, wie sie im Demo-GIF gezeigt wird? -Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). +Autovervollständigung wird von der Shell deiner Wahl bereitgestellt. In der Demo wurde die [Fish Shell](https://fishshell.com/) benutzt, welche Standardmäßig eine Autovervollständigung beinhaltet. Wenn du die Z Shell (zsh) nutzt, empfehle ich dir, einen Blick auf [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) zu werfen. -## Do top level `format` and `.disabled` do the same thing? +## Bewirken Top Level `format` und `.disabled` dasselbe? Ja, beide können benutzt werden, um Module in der Prompt zu deaktivieren. Wenn nur Module deaktiviert werden wollen, sollte `.disabled` benutzt werden, aus den folgenden Gründen: -- Disabling modules is more explicit than omitting them from the top level `format` +- Die Deaktivierung von Modulen ist expliziter, als nur das Weglassen vom Top Level `format` - Mit der Aktualisierung von Starship werden neu erstellte Module an die Eingabezeile angefügt ## Die Dokumentation sagt, dass die Starship interkompatibel ist. Warum wird meine bevorzugte Shell nicht unterstützt? @@ -48,9 +48,9 @@ starship prompt --help Die Eingabeaufforderung verwendet so viel Kontext wie möglich, aber keine Flagge ist "notwendig". -## How do I run Starship on Linux distributions with older versions of glibc? +## Wie führe ich Starship auf Linux-Distributionen mit älteren Versionen von glibc aus? -If you get an error like "_version 'GLIBC_2.18' not found (required by starship)_" when using the prebuilt binary (for example, on CentOS 6 or 7), you can use a binary compiled with `musl` instead of `glibc`: +Wenn Sie einen Fehler wie "_Version 'GLIBC_2 erhalten.' nicht gefunden (wird von starship benötigt)_" wenn das vorkompilierte Programm verwendet wird (zum Beispiel auf CentOS 6 oder 7), Sie können eine Binärdatei verwenden, die mit `musl` anstelle von `glibc` kompiliert wurde: ```sh curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl @@ -60,13 +60,13 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](../config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings. -## I see symbols I don't understand or expect, what do they mean? +## Ich sehe Symbole, die ich nicht verstehe oder erwarte, was bedeuten sie? -If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules. +Wenn du Symbole siehst, die du nicht kennst, kannst du `starship explain` verwenden um die aktuell angezeigten Module erklären zu lassen. ## Starship is doing something unexpected, how can I debug it? -You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module. +Sie können die Debug-Logs aktivieren, indem Sie die `STARSHIP_LOG` Umgebungsvariable verwenden. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module. ```sh env STARSHIP_LOG=trace starship module rust diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index a7bf56776..97d4a2dce 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Trage folgendes am Ende von `~/.config/fish/rc.elv` ein: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ Falls du Starship weiter anpassen möchtest: ## 🤝 Mitwirken -Wir sind immer auf der Suche nach Helfern **jeder Erfahrungsstufe**! Probleme mit dem Label [„Good first issues“](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) sind der beste Weg, um dich mit dem Projekt vertraut zu machen. +Wir sind immer auf der Suche nach Helfern **jeder Erfahrungsstufe**! 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/). diff --git a/docs/de-DE/presets/README.md b/docs/de-DE/presets/README.md index 1bb5a1148..4d2b8facf 100644 --- a/docs/de-DE/presets/README.md +++ b/docs/de-DE/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/de-DE/presets/catppuccin-powerline.md b/docs/de-DE/presets/catppuccin-powerline.md index 7d4600493..0c9d91991 100644 --- a/docs/de-DE/presets/catppuccin-powerline.md +++ b/docs/de-DE/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/de-DE/presets/pure-preset.md b/docs/de-DE/presets/pure-preset.md index 68a28a1bc..7ec1d0eb8 100644 --- a/docs/de-DE/presets/pure-preset.md +++ b/docs/de-DE/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Zurück zu den Voreinstellungen](./#pure) +[Zurück zu den Voreinstellungen](./#pure-prompt) # Pure Voreinstellung diff --git a/docs/de-DE/presets/tokyo-night.md b/docs/de-DE/presets/tokyo-night.md index bf9dfb254..8a1d76a14 100644 --- a/docs/de-DE/presets/tokyo-night.md +++ b/docs/de-DE/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Zurück zu den Voreinstellungen](./#pastel-powerline) +[Zurück zu den Voreinstellungen](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index d0fc13777..7251d82f5 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Sólo se admite elvish v0.18 o superior. - - ::: - - Añade el siguiente código al final de `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,13 +161,9 @@ onMounted(() => { #### Nushell - ::: warning + > [!WARNING] This will change in the future. Sólo se admite Nushell v0.96+. - Esto cambiará en el futuro. Sólo se admite Nushell v0.96+. - - ::: - - Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): + Agregue lo siguiente al final de su configuración de Nushell (encuéntrelo ejecutando `$nu.config-path` en Nushell): ```sh mkdir ($nu.data-dir | path join "vendor/autoload") diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index fbc2694dc..63cd3cf05 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -2,11 +2,7 @@ A pesar de que Starship es una prompt versátil, a veces necesitas hacer más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship. -::: warning - -Las configuraciones de esta sección están sujetos a cambios en futuras versiones de Starship. - -::: +> [!ADVERTENCIA] Las configuraciones de esta sección están sujetas a cambios en futuras versiones de Starship. ## Prompt Transitoria en PowerShell @@ -80,21 +76,21 @@ starship init fish | source enable_transience ``` -## TransientPrompt and TransientRightPrompt in Bash +## TransientPrompt y TransientRightPrompt en Bash -The [Ble.sh](https://github.com/akinomyoga/ble.sh) framework at v0.4 or higher allows you to replace the previous-printed prompt with custom strings. Esto es útil en los casos en que la información del prompt no es siempre necesaria. To enable this, put this in `~/.bashrc` `bleopt prompt_ps1_transient=`: +El marco estructura [Ble.sh](https://github.com/akinomyoga/ble.sh) en v0.4 o superior le permite reemplazar el mensaje impreso previamente con cadenas personalizadas. Esto es útil en los casos en que la información del prompt no es siempre necesaria. Para habilitar esto, coloque esto en `~/.bashrc` `bleopt prompt_ps1_transient=`: -The \ here is a colon-separated list of `always`, `same-dir` and `trim`. When `prompt_ps1_final` is empty and the option `prompt_ps1_transient` has a non-empty \, the prompt specified by `PS1` is erased on leaving the current command line. If \ contains a field `trim`, only the last line of multiline `PS1` is preserved and the other lines are erased. Otherwise, the command line will be redrawn as if `PS1=` is specified. When a field `same-dir` is contained in \ and the current working directory is different from the final directory of the previous command line, this option `prompt_ps1_transient` is ignored. +El \ aquí es una lista separada por dos puntos de `siempre`, `mismo-dir` y `recortar`. Cuando `prompt_ps1_final` está vacío y la opción `prompt_ps1_transient` tiene un \ no vacío, el mensaje especificado por `PS1` se borra al salir de la línea de comando actual. Si \ contiene un campo `trim`, solo se conserva la última línea de la multilínea `PS1` y las demás líneas se borran. De lo contrario, la línea de comando se volverá a dibujar como si se hubiera especificado `PS1=`. Cuando un campo `same-dir` está contenido en \ y el directorio de trabajo actual es diferente del directorio final de la línea de comando anterior, esta opción `prompt_ps1_transient` se ignora. -Make the following changes to your `~/.blerc` (or in `~/.config/blesh/init.sh`) to customize what gets displayed on the left and on the right: +Realice los siguientes cambios en su `~/.blerc` (o en `~/.config/blesh/init.sh`) para personalizar lo que se muestra a la izquierda y a la derecha: -- To customize what the left side of input gets replaced with, configure the `prompt_ps1_final` Ble.sh option. For example, to display Starship's `character` module here, you would do +- Para personalizar con qué se reemplaza el lado izquierdo de la entrada, configure la opción `prompt_ps1_final` de Ble.sh. Por ejemplo, para mostrar el módulo de `personaje` de Starship aquí, harías ```bash bleopt prompt_ps1_final='$(starship module character)' ``` -- To customize what the right side of input gets replaced with, configure the `prompt_rps1_final` Ble.sh option. Por ejemplo, para mostrar la hora en la que se inició el último comando aquí, lo harías +- Para personalizar con qué se reemplaza el lado derecho de la entrada, configure la opción `prompt_rps1_final` de Ble.sh. Por ejemplo, para mostrar la hora en la que se inició el último comando aquí, lo harías ```bash bleopt prompt_rps1_final='$(starship module time)' @@ -225,9 +221,9 @@ Algunos intérpretes de comandos soportan un prompt derecho que se renderiza en Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. Para alinear los módulos arriba de la línea de entrada en un prompt multi-línea, vea el [módulo de `relleno`](../config/#fill). -`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash. +`right_format` actualmente es compatible con los siguientes shells: elvish, fish, zsh, xonsh, cmd, nushell, bash. -Note: The [Ble.sh](https://github.com/akinomyoga/ble.sh) framework v0.4 or higher should be installed in order to use right prompt in bash. +Nota: Se debe instalar el framework [Ble.sh](https://github.com/akinomyoga/ble.sh) v0.4 o superior para poder utilizar el indicador correcto en bash. ### Ejemplo @@ -266,7 +262,7 @@ Nota: Los prompts de continuación solo están disponibles en los siguientes int ```toml # ~/.config/starship.toml -# A continuation prompt that displays two filled-in arrows +# Un mensaje de continuación que muestra dos flechas rellenas continuation_prompt = '▶▶ ' ``` @@ -287,7 +283,7 @@ Las cadenas de estilo son una lista de palabras, separadas por espacios en blanc - `` - `ninguno` -donde `` es un especificador de color (discutido a continuación). `fg:` y `` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. `` can also be set to `prev_fg` or `prev_bg` which evaluates to the previous item's foreground or background color respectively if available or `none` otherwise. `inverted` cambia el fondo y los colores de primer plano. El orden de las palabras en la cadena no importa. +donde `` es un especificador de color (discutido a continuación). `fg:` y `` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. `` también se puede configurar como `prev_fg` o `prev_bg`, que evalúa el color de primer plano o de fondo del elemento anterior respectivamente si está disponible o `none` en caso contrario. `inverted` cambia el fondo y los colores de primer plano. El orden de las palabras en la cadena no importa. El token `none` anula todos los demás tokens en una cadena si no es parte de un especificador `bg:`, de modo que por ejemplo `fg:red none fg:blue` creará una cadena sin ningún estilo. `bg:none` establece el fondo al color por defecto, así que `fg:red bg:none` es equivalente a `red` o `fg:red` y `bg:green fg:red bg:none` también es equivalente a `fg:red` o `red`. Puede convertirse en un error usar `none` junto con otros estilos en el futuro. diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 5b399ec66..c2a8d4b9b 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -74,16 +74,16 @@ Por convención, la mayoría de los módulos tienen un prefijo del color por def ### Cadenas de Texto -In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`. +En la sintaxis TOML, los [valores de texto](https://toml.io/en/v1.0.0#string) se declaran con `'`, `"`, `'''` o `"""`. -The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. +Los siguientes símbolos de sintaxis de Starship tienen un uso especial en una cadena de formato y deben escaparse para mostrarse como ese carácter: `$ [ ] ( )`. -| Simbol | Tipo | Notas | -| ------ | ------------------------- | ------------------------------------------------------ | -| `'` | literal string | less escaping | -| `"` | string | more escaping | -| `'''` | multi-line literal string | less escaping | -| `"""` | multi-line string | more escaping, newlines in declarations can be ignored | +| Simbol | Tipo | Notas | +| ------ | -------------------------- | ------------------------------------------------------ | +| `'` | cadena literal | menos escapes | +| `"` | cadena | mas escapes | +| `'''` | cadena literal multilineas | menos escapes | +| `"""` | multi-line string | more escaping, newlines in declarations can be ignored | Por ejemplo: @@ -208,11 +208,7 @@ Esta es la lista de opciones de configuración del prompt. | `paletas` | `{}` | Colección de paletas de colores que asignan [colores](../advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Ejemplo @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' El módulo `azure` muestra la suscripción Azure actual. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Variable | Predeterminado | Descripción | @@ -496,10 +496,10 @@ El módulo `battery` muestra qué tan cargada está la batería del dispositivo | Opción | Predeterminado | Descripción | | -------------------- | --------------------------------- | ------------------------------------------------------------------------ | | `full_symbol` | `'󰁹 '` | Se muestra cuando la batería está cargada. | -| `charging_symbol` | `'󰂄 '` | Se muestra cuando la batería se está cargando. | -| `discharging_symbol` | `'󰂃 '` | Se muestra cuando la batería se está descargando. | -| `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. | +| `charging_symbol` | `'󰁹 '` | Se muestra cuando la batería se está cargando. | +| `discharging_symbol` | `'󰁹 '` | Se muestra cuando la batería se está descargando. | +| `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. | | `disabled` | `false` | Desactiva el módulo `battery`. | @@ -658,15 +658,13 @@ El módulo `c` muestra información sobre su compilador de C. Por defecto el mó | symbol | | Refleja el valor de la opción `symbol` | | style | | Refleja el valor de la opción `style` | -NB que `versión` no está en el formato por defecto. - ### Commands La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT. -Si un compilador C no es compatible con este módulo, puede solicitarlo [planteando un problema en GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Ejemplo @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Refleja el valor de la opción `symbol` | | style | | Refleja el valor de la opción `style` | -NB que `versión` no está en el formato por defecto. - ### Commands La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Ejemplo @@ -735,11 +733,7 @@ El caracter te dirá si el último comando fue exitoso o no. Se puede hacer de d Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). -::: warning - -`vicmd_symbol` solo es compatible con cmd, fish y zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Opciones @@ -855,13 +849,11 @@ El módulo `cobol` muestra la versión instalada de COBOL. Por defecto, el módu El módulo `cmd_duration` muestra cuánto tiempo tomó ejecutarse el último comando. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time` si existe. -::: warning No utilizar la trampa DEBUG en Bash +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -Si estás usando Starship con `Bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. - -::: - -Los usuarios de Bash que necesiten la funcionalidad como preexec pueden usar el [framework bash_preexec de rcaloras](https://github.com/rcaloras/bash-preexec). Basta con definir los arreglos `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). Basta con definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre. ### Opciones @@ -897,13 +889,9 @@ 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. -::: tip - -Esto no modifica el propio símbolo de sistema de Conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Opciones @@ -970,7 +958,7 @@ 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/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `shard.yml` - El directorio actual contiene un fichero `.cr` @@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) ' ## Dart -El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo con la extensión `.dart` - El directorio actual contiene un directorio `.dart_tool` @@ -1087,7 +1075,7 @@ 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/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Opciones -| Opción | Predeterminado | 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 deben activar este módulo (necesita `solly_with_files` para ser verdadero). | -| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Qué nombres de archivo deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). | -| `style` | `'blue bold'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `docker_context`. | +| Opción | Predeterminado | 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 deben activar este módulo (necesita `solly_with_files` para ser verdadero). | +| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Qué nombres de archivo deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). | +| `style` | `'blue bold'` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `docker_context`. | ### Variables @@ -1426,26 +1416,17 @@ El módulo `env_var` muestra el valor actual de una variable de entorno seleccio - La opción de configuración de `variable` coincide con una variable de entorno existente - La opción de configuración de `variable` no está definida, pero la opción de configuración se encuentra `por defecto` -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Múltiples variables de entorno pueden mostrarse usando una `.`. (ver ejemplo) Si la opción de configuración de la `variable` no está definida, el módulo mostrará el valor de la variable bajo el nombre del texto después del caracter `.`. - -Ejemplo: la siguiente configuración mostrará el valor de la variable de entorno USER - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!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 +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Opciones @@ -1596,10 +1577,49 @@ Produce un prompt que se ve como: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Opciones + +| Opción | Predeterminado | Descripción | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `symbol` | `' '` | El símbolo usado antes de mostrar la versión de COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | +| `version_format` | `'${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | El estilo del módulo. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `['fpm.toml']` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | Cómo detectar cuál compilador es | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| name | gfortran | El nombre del compilador | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -1759,6 +1781,7 @@ El módulo `git_branch` muestra la rama activa del repositorio en tu directorio | `truncation_symbol` | `'…'` | El símbolo usado para indicar que un nombre de rama fue truncado. You can use `''` for no symbol. | | `only_attached` | `false` | Mostrar solo el hash de la confirmación de git cuando esté en estado "detached `HEAD`" | | `ignore_branches` | `[]` | Una lista de nombres a evitar ser visualizados. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Deshabilita el módulo `git_branch`. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' El módulo `git_metrics` mostrará el número de líneas añadidas y eliminadas en el repositorio git actual. -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. ### Opciones @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' El módulo `git_status` muestra símbolos que representan el estado del repositorio en su directorio actual. -::: tip - -El módulo Git Status es muy lento en los directorios de Windows (por ejemplo bajo `/mnt/c/`) en un entorno WSL. Puedes desactivar el módulo o utilizar la opción `windows_starship` para usar un ejecutable de la Starship nativa de Windows para calcular `git_status` para esas rutas. - -::: +> [!TIP] The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. Puedes desactivar el módulo o utilizar la opción `windows_starship` para usar un ejecutable de la Starship nativa de Windows para calcular `git_status` para esas rutas. ### Opciones @@ -1925,7 +1940,7 @@ El módulo Git Status es muy lento en los directorios de Windows (por ejemplo ba | `diverged` | `'⇕'` | El formato de `diverged` | | `up_to_date` | `''` | El formato de `up_to_date` | | `sin seguimiento` | `'?'` | El formato de `untracked` | -| `stashed` | `'$'` | El formato de `stashed` | +| `stashed` | `'\$'` | El formato de `stashed` | | `modificado` | `'!'` | El formato de `modified` | | `staged` | `'+'` | El formato de `staged` | | `renamed` | `'»'` | El formato de `renamed` | @@ -2392,17 +2407,9 @@ La funcionalidad por defecto es: - 1 tarea -> `symbol` se muestra. - 2 tareas o más -> `symbol` + `number` son mostrados. -::: warning +> [!WARNING] This module is not supported on tcsh. -Este módulo no está soportado por tcsh y nu. - -::: - -::: warning - -La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrará el número de tareas en ejecución si hay más de 1 tarea, o más que el valor de configuración `threshold`, si existe. Si `threshold` se establece en 0, entonces el módulo también se mostrará cuando haya 0 tareas en ejecución. - -::: +> [!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. ### Opciones @@ -2428,7 +2435,7 @@ La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrar *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo -### Ejemplo +### Ejemplos ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## 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: @@ -2530,21 +2545,13 @@ kotlin_binary = 'kotlinc' Muestra el nombre actual del [contexto de Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) y, si se establece, el espacio de nombres, el usuario y el clúster del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-context --namespace astronaut`. 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`. -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Opciones -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Opción | Predeterminado | Descripción | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true El módulo `localip` muestra la dirección IPv4 de la interfaz de red principal. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -2742,11 +2751,7 @@ El módulo `memory_usage` muestra la memoria del sistema actual y el uso de la m Por defecto, el uso de la memoria de intercambio se muestra si no es cero. -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. ### Opciones @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Estado Mercurial + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + +### Opciones + +| Opción | Predeterminado | Descripción | +| ------------ | --------------------------- | ------------------------------------------------------------------------- | +| `fusionar` | `'FUSIONANDO'` | Una cadena de formato que se muestra cuando un `merge` está en progreso. | +| `rebase` | `'REBASING'` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. | +| `actualizar` | `'ACTUALIZANDO'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `trasplante` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | El estilo del módulo. | +| `format` | `'\([$state]($style)\) '` | El formato del módulo. | +| `disabled` | `true` | Desactiva el módulo `git_state`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| ---------------- | ---------- | ------------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | El progreso de la operación actual | +| progress_total | `2` | El progreso total de la operación | +| style\* | | Refleja el valor de la opción `style` | + +*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | ------------------------------------ | ---------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | El símbolo usado antes de mostrar la versión de Zig. | -| `style` | `'bold bright-blue'` | El estilo del módulo. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | 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. | +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | 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. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. ### Opciones @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch es lo mejor! " ## Package Version -El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de - [**Maven**](https://maven.apache.org/) - La versión de paquete `maven` se extrae de `pom.xml` presente en el directorio actual - [**Meson**](https://mesonbuild.com/) - La versión del paquete `meson` se extrae de `meson.build` presente en el directorio actual - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - La versión del paquete `shards` se extrae de `shard.yml` presente en el directorio actual +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - La versión del paquete `vlang` se extrae de `v.mod` presente en el directorio actual - [**SBT**](https://scala-sbt.org) - La versión del paquete `sbt` se extrae del archivo `build.sbt` presente en el directorio actual - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Opciones @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | El símbolo usado antes del nombre del entorno. | -| `style` | `'yellow bold' | El estilo del módulo. | +| `style` | `'yellow bold'` | El estilo del módulo. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['pixi.toml']` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `['.pixi']` | Qué carpetas deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' El módulo `pulumi` muestra el nombre de usuario actual, [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/)seleccionado y la versión. -::: tip - -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). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-pulumi-version). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: @@ -3712,13 +3742,9 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | `detect_folders` | `[]` | Qué carpetas deben activar este módulo | | `disabled` | `false` | Deshabilita el módulo `python`. | -::: tip - -La variable `python_binary` acepta una cadena o una lista de cadenas. La Starship intentará ejecutar cada binario hasta que obtenga un resultado. Ten en cuenta que sólo puedes cambiar el binario que Starship ejecuta para obtener la versión de Python no los argumentos que se utilizan. - -Los valores por defecto y el orden para `python_binary` fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un `python`, no importa si apunta a `python3` o `python2`). Esto tiene el efecto secundario que si todavía tienes un sistema de Python 2 instalado, puede ser recogido antes de cualquier Python 3 (al menos en las Distros de Linux que siempre enlazan `/usr/bin/python` a Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!TIP] The `python_binary` variable accepts either a string or a list of strings. La Starship intentará ejecutar cada binario hasta que obtenga un resultado. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. +> +> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. ### Variables @@ -4036,11 +4062,7 @@ symbol = '🌟 ' El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado. -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. ### Opciones @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. + ### Opciones | Opción | Predeterminado | Descripción | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' El módulo `status` muestra el código de salida del comando anterior. Si $success_symbol está vacío (por defecto), el módulo solo se mostrará si el código de salida no es `0`. El código de estado se convertirá a un entero con signo de 32 bits. -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. ### Opciones @@ -4305,11 +4325,7 @@ disabled = false El módulo `sudo` muestra si las credenciales de sudo están actualmente en caché. El módulo solo se mostrará si las credenciales están guardadas en caché. -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. ### Opciones @@ -4391,13 +4407,9 @@ format = 'vía [🏎 $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. +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. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: tip - -Por defecto no se muestra la versión de Terraform, ya que esto es lento para las versiones actuales de Terraform cuando hay muchos plugins en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: @@ -4406,16 +4418,17 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | La cadena de formato para el módulo. | -| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | Una cadena de formato que se muestra antes del espacio de trabajo terraform. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `['.terraform']` | Qué carpetas deberían activar este módulo. | -| `style` | `'bold 105'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `terraform`. | +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | La cadena de formato para el módulo. | +| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | Una cadena de formato que se muestra antes del espacio de trabajo terraform. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `['.terraform']` | Qué carpetas deberían activar este módulo. | +| `style` | `'bold 105'` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `terraform`. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Sin Terraform Version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por el crate de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles. -::: tip - -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. - -::: +> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. ### Opciones @@ -4537,11 +4546,7 @@ El módulo `username` muestra el nombre de usuario activo. El módulo se mostrar - La variable `show_always` se establece en true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: tip - -La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si tu host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto. - -::: +> [!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. ### Opciones @@ -4684,6 +4689,35 @@ El módulo `vcsh` muestra el repositorio activo [VCSH](https://github.com/RichiH format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). Por defecto el módulo se activará si se cumplen cualquiera de las siguientes condiciones: + +- El directorio actual contiene un archivo `xmake.lua` + +### Opciones + +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | +| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | El símbolo usado antes de la versión de cmake. | +| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo | +| `detect_files` | `['xmake.lua']` | Qué nombres de archivo deben activar este módulo | +| `detect_folders` | `[]` | Qué carpetas deben activar este módulo | +| `style` | `'bold green'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones: @@ -4734,31 +4768,17 @@ Estos módulos se mostrarán si se cumple alguna de las siguientes condiciones: - El comando `when` devuelve 0 - El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Múltiples módulos personalizados pueden definirse usando un `.` (un punto). +> [!TIP] The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). Por defecto, el módulo `personalizado` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos. -::: +> [!TIP] [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. ¡Si tienes un ejemplo interesante no cubierto, siéntete libre de compartirlo ahí! -::: tip - -El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `personalizado` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos. - -::: - -::: tip - -[El problema #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. ¡Si tienes un ejemplo interesante no cubierto, siéntete libre de compartirlo ahí! - -::: - -::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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 @@ -4808,17 +4828,15 @@ Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell shell = ['pwsh', '-Command', '-'] ``` -::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito - -Si estableces un comando personalizado, asegúrate de que el intérprete de comandos por defecto usado por Starship ejecutará correctamente el comando con una salida elegante (a través de la opción `shell`). - -Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a Starship a un bucle recursivo donde el intérprete de comandos podría intentar cargar un entorno de perfil completo con Starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito. - -Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros intérprete de comandos también para evitar tiempo extra de carga de un perfil personalizado en cada invocación de Starship. - -La detección automática de intérpretes de comandos y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los intérpretes de comandos estén cubiertos. Por favor, [abre un problema](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Ejemplo diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index 633e4f78e..a5a273eda 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -35,7 +35,7 @@ Stand With Ukraine

@@ -221,21 +221,22 @@ curl -sS https://starship.rs/install.sh | sh Alternativamente, instale Starship usando cualquiera de los siguientes gestores de paquetes: -| Distribución | Repositorio | Instrucciones | -| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| **_Cualquiera_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | -| _Cualquiera_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | -| _Cualquiera_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | -| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | -| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | -| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | -| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | -| Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | -| Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | -| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | -| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | -| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | +| Distribución | Repositorio | Instrucciones | +| ------------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| **_Cualquiera_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | +| _Cualquiera_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | +| _Cualquiera_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | +| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | +| Arch Linux | [Extra de Archi Linux](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | +| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | +| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | +| Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | +| Manjaro | | `pacman -S starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | +| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | +| Ubuntu 25.04 o más nuevo | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | +| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -276,7 +277,7 @@ Instalar Starship usando cualquiera de los siguientes gestores de paquetes: -### Paso 2. Set up your shell to use Starship +### Paso 2. Configure su consola para usar Starship Configure su shell para inicializar starship. Selecciona el tuyo de la lista de abajo: @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Añade el siguiente código al final de `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Nota: Sólo se admite Elvish v0.18+ +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -340,11 +341,12 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): +Agregue lo siguiente al final de su configuración de Nushell (encuéntrelo ejecutando `$nu.config-path` en Nushell): ```sh mkdir ($nu.data-dir | path join "vendor/autoload") starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu") + ``` Nota: Sólo se admite Nushell v0.96+ @@ -407,7 +409,7 @@ Si estás buscando personalizar Starship: ## 🤝 Contribuir -¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si estas buscando una manera fácil de ayudar este proyecto, puedes intentar resolver un problema con la etiqueta "[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)". +¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si buscas avanzar gradualmente en el proyecto, prueba con un [buen primer número](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue"). Si habla con fluidez en un idioma que no es 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/). @@ -427,16 +429,16 @@ Por favor, revisa estas obras anteriores que ayudaron a inspirar la creación de Apoya este proyecto [convirtiéndote en patrocinador](https://github.com/sponsors/starship). Tu nombre o logo aparecerá aquí con un enlace a tu sitio web. -## 🔒 Code Signing Policy +## Política de Firmado de Código -Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org). +Firma de código gratuita proporcionada por [SignPath.io](https://signpath.io), certificado por [SignPath Foundation](https://signpath.org). -Code Signing Roles: +Roles de Firmado de Código: -- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts) -- Approvers and Authors: [Mission Control](https://github.com/orgs/starship/teams/mission-control) +- Revisores: [Astronauts](https://github.com/orgs/starship/teams/astronauts) +- Aprobadores y Autores: [Mission Control](https://github.com/orgs/starship/teams/mission-control) -This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it. +Este programa no transferirá ninguna información a otros sistemas en red a menos que lo solicite específicamente el usuario o la persona que lo instale u opere.


diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md index c25f505c5..ddd717251 100644 --- a/docs/es-ES/presets/README.md +++ b/docs/es-ES/presets/README.md @@ -14,11 +14,7 @@ Este preajuste cambia los símbolos de cada módulo para usar símbolos Nerd Fon This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/es-ES/presets/catppuccin-powerline.md b/docs/es-ES/presets/catppuccin-powerline.md index 41dcfa0c9..ae8614d93 100644 --- a/docs/es-ES/presets/catppuccin-powerline.md +++ b/docs/es-ES/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/es-ES/presets/pure-preset.md b/docs/es-ES/presets/pure-preset.md index d877434f7..62a3d574c 100644 --- a/docs/es-ES/presets/pure-preset.md +++ b/docs/es-ES/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Volver a Preajustes](./#pure) +[Volver a Preajustes](./#pure-prompt) # Preajuste Pure diff --git a/docs/es-ES/presets/tokyo-night.md b/docs/es-ES/presets/tokyo-night.md index 6b999b679..d72ac50a7 100644 --- a/docs/es-ES/presets/tokyo-night.md +++ b/docs/es-ES/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Volver a Preajustes](./#pastel-powerline) +[Volver a Preajustes](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md index 8801d759b..27d03bf33 100644 --- a/docs/fr-FR/README.md +++ b/docs/fr-FR/README.md @@ -18,7 +18,7 @@ features: details: Profitez de toute la rapidité et la sécurité de Rust pour rendre votre invite de commandes la plus rapide et fiable possible. - title: Personnalisable - details: Tous les petits détails sont personnalisable à votre goût, pour rendre votre invite de commandes aussi légère ou complète que le vous souhaitez. + details: Tous les petits détails sont personnalisables à votre goût, pour rendre votre invite de commandes aussi légère ou complète que vous le souhaitez. footer: Licence ISC | Copyright © 2019-présent Contributeurs Starship #Used for the description meta tag, for SEO metaTitle: "Starship : Invite Multi-Shell" @@ -46,7 +46,7 @@ onMounted(() => { ### Pré-requis -- Une [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal. +- Une police d'écriture [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal. ### Installation @@ -72,7 +72,7 @@ onMounted(() => { brew install starship ``` - With [Winget](https://github.com/microsoft/winget-cli): + Avec [Winget](https://github.com/microsoft/winget-cli): ```powershell winget install starship @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Seul elvish v0.18 ou supérieur est pris en charge. - - ::: - - Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,13 +161,9 @@ onMounted(() => { #### Nushell - ::: warning + > [!WARNING] This will change in the future. Seul Nushell v0.96+ est supporté. - Ceci va changer dans le futur. Seul Nushell v0.96+ est supporté. - - ::: - - Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): + Ajoutez la ligne suivante à la fin de votre configuration Nushell (trouvable en exécutant `$nu.config-path` dans Nushell) : ```sh mkdir ($nu.data-dir | path join "vendor/autoload") diff --git a/docs/fr-FR/advanced-config/README.md b/docs/fr-FR/advanced-config/README.md index 22651b4b2..076117738 100644 --- a/docs/fr-FR/advanced-config/README.md +++ b/docs/fr-FR/advanced-config/README.md @@ -2,11 +2,7 @@ Même si Starship est un shell polyvalent, éditer `starship.toml` ne suffit parfois pas pour faire certaines choses. Cette page détaille quelques techniques de configuration avancées utilisées dans starship. -::: warning - -Les configurations dans cette section sont sujettes à modification dans les futures versions de Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index 351fb1802..fee1282d0 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -208,11 +208,7 @@ Voici la liste des options de configuration globales de l'invite de commandes. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Exemple @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' Le module `azure` affiche l'abonnement Azure actuel. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Variable | Défaut | Description | @@ -658,15 +658,13 @@ Le module `c` affiche des informations à propos de votre compilateur C. Par dé | symbole | | Reflète la valeur de l'option `symbol` | | style | | Reflète la valeur de l'option `style` | -Notez que `version` n’est pas dans le format par défaut. - ### Commandes L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT. -Si un compilateur C n’est pas supporté par ce module, vous pouvez demander son ajout en [créant un ticket sur GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Exemple @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbole | | Reflète la valeur de l'option `symbol` | | style | | Reflète la valeur de l'option `style` | -Notez que `version` n’est pas dans le format par défaut. - ### Commandes L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Exemple @@ -735,11 +733,7 @@ Le caractère vous dira si la dernière commande a été réussie ou pas. Il peu 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,13 +849,11 @@ Le module `cobol` affiche la version de COBOL installée. Par défaut, le module Le module `cmd_duration` montre le temps qu'a pris la dernière commande pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou plus que la valeur `min_time`, si elle existe. -::: warning N'accrochez pas la trappe DEBUG en Bash +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -Si vous utilisez starship avec `bash`, n'interceptez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **ne fonctionnera pas**. - -::: - -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 tableaux `preexec_functions` et `precmd_functions` avant d'exé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). Définissez simplement les tableaux `preexec_functions` et `precmd_functions` avant d'exécuter `eval $(starship init $0)`, puis procédez comme d'habitude. ### Options @@ -897,13 +889,9 @@ 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 pourriez vouloir exécuter `conda config --set changeps1 False` pour le désactiver. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -970,7 +958,7 @@ format = '[$symbol \[$name\]]($style) ' ## Crystal -Le module `crystal` affiche la version de [Crystal](https://crystal-lang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `shard.yml` - Le dossier courant contient un fichier `.cr` @@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) ' ## Dart -Le module `dart` affiche la version de [Dart](https://dart.dev/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier avec l’extension `.dart` - Le dossier courant contient un fichier `.dart_tool` @@ -1087,7 +1075,7 @@ format = 'via [🔰 $version](bold red) ' ## Deno -Le module `deno` affiche la version de [Deno](https://deno.land/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol$context]($style) '` | Format du module. | -| `symbole` | `'🐳 '` | 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 pour le module. | -| `disabled` | `false` | Désactive le module `docker_context`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| `format` | `'via [$symbol$context]($style) '` | Format du module. | +| `symbole` | `'🐳 '` | 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` | `['compose.yml', 'compose.yaml', '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 pour le module. | +| `disabled` | `false` | Désactive le module `docker_context`. | ### Variables @@ -1426,26 +1416,17 @@ Le module `env_var` affiche la valeur actuelle de la variable d’environnement - L'option `variable` correspond à une variable d'environnement existante - L'option `variable` n'est pas définie, mais l'option `default` l'est -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Plusieurs variables d’environnement peuvent être affichées en utilisant un `.`. (voir exemple). Si l’option de configuration `variable` n’est pas définie, le module affichera la valeur de la variable dont le nom est le texte après le caractère `.`. - -Exemple : la configuration suivante va afficher la valeur de la variable d’environnement UTILISATEUR - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!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. +> +> Exemple : la configuration suivante va afficher la valeur de la variable d’environnement UTILISATEUR +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produit une invite qui ressemble à : AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Défaut | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| `symbole` | `' '` | Le symbole utilisé avant d’afficher la version de COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | Format du module. | +| `version_format` | `'${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | Le style pour le module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Les extensions qui déclenchent ce module. | +| `detect_files` | `['fpm.toml']` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | Comment détecter quel est le compilateur | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Exemple | Description | +| --------- | -------- | -------------------------------------- | +| name | gfortran | Le nom du compilateur | +| version | `14.2.0` | The version of the Fortran compiler | +| symbole | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | + +*: Cette variable peut uniquement être utilisée dans une chaine de style + +### Commandes + +L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -1759,6 +1781,7 @@ Le module `git_branch` affiche la branche active du dépôt dans le dossier cour | `truncation_symbol` | `'…'` | Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. You can use `''` for no symbol. | | `only_attached` | `false` | Ne montrer le nom de la branche que si elle n'est pas dans un état `HEAD` détachée. | | `ignore_branches` | `[]` | Une liste de noms à ne pas afficher. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Désactive le module `git_branch`. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' Le module `git_metrics` affiche le nombre de lignes ajoutées et supprimées dans le dépôt Git courant. -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' Le module `git_status` affiche des symboles représentant l’état du dépôt dans le dossier courant. -::: tip - -Le module Statut Git est très lent dans les dossiers Windows (par exemple sous `/mnt/c/`) dans un environnement WSL. Vous pouvez désactiver le module ou utiliser l’option `windows_starship` pour utiliser un exécutable Starship natif pour calculer le `git_status` pour ces chemins. - -::: +> [!TIP] The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. Vous pouvez désactiver le module ou utiliser l’option `windows_starship` pour utiliser un exécutable Starship natif pour calculer le `git_status` pour ces chemins. ### Options @@ -1925,7 +1940,7 @@ Le module Statut Git est très lent dans les dossiers Windows (par exemple sous | `diverged` | `'⇕'` | Le format de `diverged` | | `up_to_date` | `''` | The format de `up_to_date` | | `untracked` | `'?'` | Le format de `untracked` | -| `stashed` | `'$'` | Le format de `stashed` | +| `stashed` | `'\$'` | Le format de `stashed` | | `modified` | `'!'` | Le format de `modified` | | `staged` | `'+'` | Le format de `staged` | | `renamed` | `'»'` | Le format de `renamed` | @@ -2392,17 +2407,9 @@ Le fonctionnement par défaut est: - 1 tâche -> `symbol` est affiché. - 2 taĉhes ou plus -> `symbol` + `number` sont affichés. -::: warning +> [!WARNING] This module is not supported on tcsh. -Ce module n'est pas pris en charge sur tcsh et nu. - -::: - -::: warning - -L’option `threshold` est dépréciée, mais si vous voulez l’utiliser, le module affichera le nombre de tâches en cours s’il y a plus d'une tâche, ou plus que la valeur de `threshold`, si elle existe. Si `threshold` est définie à 0, alors le module s'affichera également lorsqu'il n'y a pas de tâches de fond en cours. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ L’option `threshold` est dépréciée, mais si vous voulez l’utiliser, le mo *: Cette variable peut uniquement être utilisée dans une chaine de style -### Exemple +### Exemples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia Le module `julia` affiche la version de [Julia](https://julialang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: @@ -2530,21 +2545,13 @@ kotlin_binary = 'kotlinc' Afficher le nom du [contexte Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) courant, et, si défini, l’espace de nom, l’utilisateur, et le cluster depuis le fichier kubeconfig. L'espace de noms doit être défini dans le fichier kubeconfig, ce qui peut être fait via `kubectl config set-context starship-cluster --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Si la variable d'environnement `$KUBECONFIG` est définie, le module l'utilisera, sinon il utilisera le fichier `~/.kube/config`. -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Défaut | Description | | ------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true Le module `localip` affiche l’adresse IPv4 de l’interface réseau principale. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -2742,11 +2751,7 @@ Le module `memory_usage` affiche la mémoire système actuelle et l'utilisation Par défaut, l'utilisation du swap est affichée si le swap total du système n'est pas nul. -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + +### Options + +| Option | Défaut | Description | +| ------------ | --------------------------- | -------------------------------------------------------------- | +| `merge` | `'MERGING'` | Une chaîne de format affichée quand un `merge` est en cours. | +| `rebase` | `'REBASING'` | Une chaîne de format affichée lorsqu'un `rebase` est en cours. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | Une chaîne de format affichée quand un `bisect` est en cours. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | Le style pour le module. | +| `format` | `'\([$state]($style)\) '` | Format du module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Exemple | Description | +| ---------------- | ---------- | ------------------------------------- | +| state | `REBASING` | L'état actuel du dépôt | +| progress_current | `1` | Progression de l'opération en cours | +| progress_total | `2` | Progression maximale de l'opération | +| style\* | | Reflète la valeur de l'option `style` | + +*: Cette variable peut uniquement être utilisée dans une chaine de style + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -3175,7 +3217,7 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `'via [$symbol($version )]($style)'` | Format du module. | | `show_commit` | `false` | Shows the commit as part of the version. | -| `symbole` | `'Ø '` | Le symbole utilisé avant d'afficher la version de Zig. | +| `symbole` | `'Ø '` | The symbol used before displaying the version of Odin. | | `style` | `'bold bright-blue'` | Le style pour le module. | | `disabled` | `false` | Disables the `odin` module. | | `detect_extensions` | `['odin']` | Les extensions qui déclenchent ce module. | @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Version du paquet -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – La version du paquet `npm` est extraite du `package.json` présent dans le répertoire courant - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - La version du paquet `sbt` est extraite du `build.sbt` présent dans le dossier courant - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | Format du module. | | `version_format` | `'v${raw}'` | Le format de la version. Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbole` | `'🧚 '` | Le symbole utilisé avant le nom d'environnement. | -| `style` | `'yellow bold' | Le style pour le module. | +| `style` | `'yellow bold'` | Le style pour le module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Les extensions qui déclenchent ce module. | | `detect_files` | `['pixi.toml']` | Les fichiers qui activent ce module. | -| `detect_folders` | `['.pixi']` | Les dossiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -Par défaut, la version de Pulumi n'est pas affichée, car cela prendre un ordre de magnitude plus de temps à charger que la plupart des plugins (~70ms). Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-pulumi-version). Par défaut, le module sera affiché si l’une de ces conditions est remplie: @@ -3712,13 +3742,9 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie: | `detect_folders` | `[]` | Quels dossiers devraient activer ce module | | `disabled` | `false` | Désactive le module `python`. | -::: tip - -La variable `python_binary` accepte soit une chaine, soit une liste de chaines de caractères. Starship essayera d'exécuter chaque binaire jusqu'à obtenir un résultat. Notez que vous ne pouvez modifier que le binaire que Starship exécute pour obtenir la version de Python, mais pas les arguments utilisés. - -The 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. - -::: +> [!TIP] The `python_binary` variable accepts either a string or a list of strings. Starship essayera d'exécuter chaque binaire jusqu'à obtenir un résultat. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. +> +> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. ### Variables @@ -4036,11 +4062,7 @@ symbol = '🌟 ' Le module `shell` affiche un indicateur en fonction du shell actuellement utilisé. -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. + ### Options | Option | Défaut | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' Le module `status` affiche le code de sortie de la commande précédente. Si $success_symbol est vide (par défaut), ce module sera affiché uniquement quand le code de sortie n’est pas `0`. Le code de statut est converti en entier signé 32 bits. -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ### Options @@ -4305,11 +4325,7 @@ disabled = false Le moduel `sudo` affiche si les identifiants sudo sont actuellement en cache. Le module sera uniquement affiché si les identifiants sont en cache. -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -Le module `terraform` affiche [l’espace de travail Terraform](https://www.terraform.io/docs/language/state/workspaces.html) sélectionné et sa version. +Le module `terraform` affiche [l’espace de travail Terraform](https://www.terraform.io/docs/language/state/workspaces.html) sélectionné et sa version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: tip - -Par défaut, la version de Terraform n’est pas affichée, car elle est lente pour les versions actuelles de Terraform quand beaucoup de plugins sont utilisés. Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-terraform-version). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-terraform-version). Par défaut, le module sera affiché si l’une de ces conditions est remplie: @@ -4406,16 +4418,17 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie: ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol$workspace]($style) '` | La chaîne de format pour le module. | -| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbole` | `'💠'` | Une chaîne de format montrée avant l'espace de travail terraform. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Les extensions qui déclenchent ce module. | -| `detect_files` | `[]` | Les fichiers qui activent ce module. | -| `detect_folders` | `['.terraform']` | Les dossiers qui activent ce module. | -| `style` | `'bold 105'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `terraform`. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| `format` | `'via [$symbol$workspace]($style) '` | La chaîne de format pour le module. | +| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `symbole` | `'💠'` | Une chaîne de format montrée avant l'espace de travail terraform. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Les extensions qui déclenchent ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `['.terraform']` | Les dossiers qui activent ce module. | +| `style` | `'bold 105'` | Le style pour le module. | +| `disabled` | `false` | Désactive le module `terraform`. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Sans la version de Terraform @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Date et Heure Le module `time` affiche la date et heure **locale**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. -::: tip - -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. - -::: +> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ### Options @@ -4537,11 +4546,7 @@ Le module `username` affiche le nom de l’utilisateur actif. Le module sera aff - La variable `show_always` est définie à true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). Par défaut, le module s’activera si l’une de ces conditions est remplie: + +- Le dossier courant contient un fichier `xmake.lua` + +### Options + +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | Format du module. | +| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `symbole` | `'△ '` | Le symbole utilisé avant la version de cmake. | +| `detect_extensions` | `[]` | Les extensions qui déclenchent ce module | +| `detect_files` | `['xmake.lua']` | Quels fichiers devraient activer ce module | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module | +| `style` | `'bold green'` | Le style pour le module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Exemple | Description | +| --------- | -------- | -------------------------------------- | +| version | `v2.9.5` | The version of xmake | +| symbole | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | + +*: Cette variable peut uniquement être utilisée dans une chaine de style + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Le module sera affiché si l'une de ces conditions est remplie: @@ -4734,31 +4768,17 @@ Ces modules seront affichés si l'une de ces conditions est remplie: - La commande `when` retourne 0 - The current Operating System (std::env::consts::OS) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Plusieurs modules personnalisés peuvent être définis en utilisant un `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Exemple diff --git a/docs/fr-FR/faq/README.md b/docs/fr-FR/faq/README.md index fc4eebfe7..c621bb536 100644 --- a/docs/fr-FR/faq/README.md +++ b/docs/fr-FR/faq/README.md @@ -16,7 +16,7 @@ L'aide à la complétion ou autocomplétion est fournie par le shell que vous av ## Est-ce que l'option globale `format` et `.disabled` font la même chose ? -Oui, ils peuvent tous deux être utilisés pour désactiver les modules dans l'invite de commande. Si tout ce que vous prévoyez de faire est de désactiver les modules, `.disabled` est le meilleur moyen de le faire pour ces raisons : +Oui, elles peuvent toutes deux être utilisées pour désactiver les modules dans l'invite de commande. Si tout ce que vous prévoyez de faire est de désactiver les modules, `.disabled` est le meilleur moyen de le faire pour ces raisons : - Désactiver les modules est plus explicite que de les omettre du `format global` - Les modules nouvellement créés seront ajoutés à l'invite de commande au fur et à mesure que Starship sera mis à jour @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) 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 à Starship est légèrement plus complexe pour permettre des fonctionnalités avancées comme le [module de 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. +L'[implémentation Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) intégrée à Starship est légèrement plus complexe pour permettre des fonctionnalités avancées comme le [module de 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 prompt`, utilisez la commande suivante : @@ -72,7 +72,7 @@ Vous pouvez activer les journaux de débogage en utilisant la variable d’envir env STARSHIP_LOG=trace starship module rust ``` -If starship is being slow you can try using the `timings` command to see if there is a particular module or command that is to blame. +Si Starship est lent, vous pouvez utiliser la commande `timings` pour vérifier si un module ou une commande en particulier est à l'origine du ralentissement. ```sh env STARSHIP_LOG=trace starship timings @@ -121,10 +121,10 @@ Si Starship a été installé en utilisant le script d'installation, la commande sh -c 'rm "$(command -v 'starship')"' ``` -## How do I install Starship without `sudo`? +## Comment installer Starship sans `sudo` ? -The shell install script (`https://starship.rs/install.sh`) only attempts to use `sudo` if the target installation directory is not writable by the current user. The default installation directory is the value of the `$BIN_DIR` environment variable or `/usr/local/bin` if `$BIN_DIR` is not set. If you instead set the installation directory to one that is writable by your user, you should be able to install starship without `sudo`. For example, `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin` uses the `-b` command line option of the install script to set the installation directory to `~/.local/bin`. +Le script d'installation (`https://starship.rs/install.sh`) essaye d'utiliser `sudo` seulement si le répertoire d'installation ciblé n'est pas disponible en écriture pour l'utilisateur actuel. Le répertoire d'installation par défaut correspond à la variable d'environnement `$BIN_DIR`, ou `/usr/local/bin` si `$BIN_DIR` n'est pas définie. Si vous avez défini à la place un répertoire d'installation accessible en écriture par votre utilisateur, vous devriez pouvoir installer Starship sans `sudo`. Par exemple, la commande `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin` utilise l'option `-b` du script d'installation pour définir le répertoire d'installation vers `~/.local/bin`. -For a non-interactive installation of Starship, don't forget to add the `-y` option to skip the confirmation. Check the source of the installation script for a list of all supported installation options. +Pour une installation non interactive de Starship, n'oubliez pas d'ajouter l'option `-y` pour passer l'étape de confirmation. Vérifiez le code source du script d'installation pour obtenir une liste de toutes les options d'installation supportées. -When using a package manager, see the documentation for your package manager about installing with or without `sudo`. +Lorsque vous utilisez un gestionnaire de paquet, référez-vous à la documentation dudit gestionnaire pour l'installation avec ou sans `sudo`. diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index c1ce3f009..9e7981a71 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -180,7 +180,7 @@ ### Pré-requis -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)). +- Une police d'écriture [Nerd Font](https://www.nerdfonts.com/) est installée et activée sur votre terminal (par exemple, essayez [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)). ### Étape 1. Installer Starship @@ -229,10 +229,11 @@ Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de | Alpine Linux 3.13+ | [Paquets Alpine Linux](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | -| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Debian 13+ | [Debian principal](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Paquets Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Paquets Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -262,7 +263,7 @@ Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de

Windows -Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). +Installez la dernière version pour votre système à partir de l'installeur MSI de la [section publication](https://github.com/starship/starship/releases/latest). Installez Starship en utilisant l’un de ces gestionnaires de paquets: @@ -276,7 +277,7 @@ Installez Starship en utilisant l’un de ces gestionnaires de paquets:
-### Étape 2. Set up your shell to use Starship +### Étape 2. Configurez votre Shell pour utiliser Starship Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous: @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Note: Seul Elvish v0.18+ est supporté +Note: Seul Elvish v0.18+ est supporté. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -340,7 +341,7 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): +Ajoutez la ligne suivante à la fin de votre configuration Nushell (trouvable en exécutant `$nu.config-path` dans Nushell) : ```sh mkdir ($nu.data-dir | path join "vendor/autoload") @@ -407,7 +408,7 @@ Si vous cherchez à personnaliser davantage Starship : ## 🤝 Contribuer -Nous sommes toujours à la recherche de contributeurs de **tous 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). +Nous sommes toujours à la recherche de contributeurs de **tous niveaux de compétence**! 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 traduire et mettre à jour notre documentation dans d'autres langues. Si vous souhaitez nous aider, les traductions se font sur le [Crowdin Starship](https://translate.starship.rs/). diff --git a/docs/fr-FR/presets/README.md b/docs/fr-FR/presets/README.md index 1b8f13ef4..40e1f92de 100644 --- a/docs/fr-FR/presets/README.md +++ b/docs/fr-FR/presets/README.md @@ -14,11 +14,7 @@ Ce préréglage change les symboles de chaque module pour utiliser les symboles This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/fr-FR/presets/catppuccin-powerline.md b/docs/fr-FR/presets/catppuccin-powerline.md index 6e1008f34..65576f50e 100644 --- a/docs/fr-FR/presets/catppuccin-powerline.md +++ b/docs/fr-FR/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/fr-FR/presets/pure-preset.md b/docs/fr-FR/presets/pure-preset.md index 848d78bfd..6b8c72882 100644 --- a/docs/fr-FR/presets/pure-preset.md +++ b/docs/fr-FR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Retourner aux préréglages](./#pure) +[Retourner aux préréglages](./#pure-prompt) # Préréglage Pure diff --git a/docs/fr-FR/presets/tokyo-night.md b/docs/fr-FR/presets/tokyo-night.md index 29f47ced5..ecdcd9c79 100644 --- a/docs/fr-FR/presets/tokyo-night.md +++ b/docs/fr-FR/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Retourner aux préréglages](./#pastel-powerline) +[Retourner aux préréglages](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/id-ID/README.md b/docs/id-ID/README.md index 6d2a2b53b..1de844d15 100644 --- a/docs/id-ID/README.md +++ b/docs/id-ID/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Hanya elvish v0.18 atau versi yang lebih baru yang mendapat dukungan pengembangan. - - ::: - - Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - Hal ini dapat berubah di kemudian hari. Hanya Nushell v0.96+ yang menerima dukungan. - - ::: + > [!WARNING] This will change in the future. Hanya Nushell v0.96+ yang menerima dukungan. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/id-ID/advanced-config/README.md b/docs/id-ID/advanced-config/README.md index cc14859b5..07cbb3f6e 100644 --- a/docs/id-ID/advanced-config/README.md +++ b/docs/id-ID/advanced-config/README.md @@ -2,11 +2,7 @@ Walaupun Starship adalah shell yang serbaguna, terkadang kita butuh upaya lebih dari sekadar mengedit `starship.toml` untuk membuatnya menjalankan beberapa hal tertentu. Halaman ini merincikan beberapa teknik konfigurasi lanjutan yang digunakan starship. -::: warning - -Konfigurasi pada bagian ini dapat berubah saat Starship terbaru rilis di kemudian hari nanti. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/id-ID/config/README.md b/docs/id-ID/config/README.md index 24605614f..66d8fa940 100644 --- a/docs/id-ID/config/README.md +++ b/docs/id-ID/config/README.md @@ -208,11 +208,7 @@ Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Contoh @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Variabel | Bawaan | Deskripsi | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Menyalin nilai dari opsi `symbol` | | style | | Menyalin nilai dari opsi `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Contoh @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Menyalin nilai dari opsi `symbol` | | style | | Menyalin nilai dari opsi `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Contoh @@ -735,11 +733,7 @@ Karakter dapat memberitahu kamu apakah perintah terakhir berhasil atau tidak. Ka Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin mengganti bentuknya, perhatikan [contoh](#with-custom-error-shape) berikut. -::: warning - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Opsi @@ -855,13 +849,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t Modul `cmd_duration` menampilkan seberapa lama perintah sebelumnya membutuhkan waktu untuk dilaksanakan. Modulnya hanya akan ditampilkan jika perintahnya membutuhkan waktu lebih dari dua detik, atau ada nilai dari konfigurasi `min_time`. -::: warning lakukan hook DEBUG trap dalam Bash +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -Jia kamu menjalankan Starship di `bash`, jangan lakukan hook DEBUG trap setelah menjalankan `eval $(starship init $0)`, atau modulnya **akan** rusak. - -::: - -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). Cukup dengan membuat array `preexec_functions` dan `precmd_functions` sebelum menjalankan `eval $(starship init $0)`, lalu lanjutkan seperti biasa. ### Opsi @@ -899,11 +891,7 @@ 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. -::: tip - -Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungkin bisa menjalankan `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Opsi @@ -970,7 +958,7 @@ 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/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: - Direktori terkini yang berisikan sebuah file `shard.yml` - Direktori terkini yang berisikan sebuah file `.cr` @@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) ' ## Dart -Modul `dart` menampilkan versi terkini dari [Dart](https://dart.dev/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: - Direktori terkini yang berisikan sebuah file berekstensi `.dart` - Direktori terkini yang berisikan sebuah direktori `dart_tool` @@ -1087,7 +1075,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/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -1251,16 +1241,16 @@ 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 | +| ------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `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` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | filenames mana yang harusnya memicu modul ini (butuh `only_with_files` untuk diset true). | +| `detect_folders` | `[]` | Folder mana yang harusnya memicu modul (butuh `only_with_files` untuk diset true). | +| `style` | `'blue bold'` | Gaya penataan untuk modul. | +| `disabled` | `false` | Menonaktifkan module `docket_context`. | ### Variabel @@ -1426,26 +1416,17 @@ Modul `env_var` menampilkan nilai terkini dari variabel environment yang dipilih - Opsi konfigurasi `variable` cocok dengan variabel environment yang ada - Opsi konfigurasi `variable` tidak didefinisikan, tapi opsi konfigurasi `default` yang didefinisikan -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (lihat contoh) Jika opsi konfigurasi `variable` tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter `.`. - -Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!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 +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Opsi @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. | +| `version_format` | `'${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | Gaya penataan untuk modul. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Ekstensi mana yang sebaiknya memicu modul ini. | +| `detect_files` | `['fpm.toml']` | filenames mana yang sebaiknya memicu modul ini. | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | ----------------------------------- | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variabel @@ -1838,7 +1861,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. | -| `fromat` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | | `disabled` | `false` | Disables the `git_state` module. | ### Variabel @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opsi @@ -1908,24 +1927,20 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Opsi | 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` | | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Opsi @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## 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: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Opsi -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Opsi | Bawaan | Deskripsi | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opsi @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | Gaya penataan untuk modul. | +| `fromat` | `'\([$state]($style)\) '` | Format dari modul. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ---------------- | ---------- | -------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Menyalin nilai dari opsi `style` | + +*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Ekstensi mana yang sebaiknya memicu modul ini. | -| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | -| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Ekstensi mana yang sebaiknya memicu modul ini. | +| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | ### Variabel @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opsi @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Opsi @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `fromat` | `'via [$symbol($version )(\($environment\) )]($style)'` | Format dari modul. | | `version_format` | `'v${raw}'` | Format dari versi. Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | Simbol yang digunakan sebelum nama environment. | -| `style` | `'yellow bold' | Gaya penataan untuk modul. | +| `style` | `'yellow bold'` | Gaya penataan untuk modul. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `['pixi.toml']` | filenames mana yang sebaiknya memicu modul ini. | -| `detect_folders` | `['.pixi']` | Folder mana yang sebaiknya memicul modul ini. | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `disabled` | `false` | Disables the `pixi` module. | ### Variabel @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!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: @@ -3712,13 +3742,9 @@ By default, the module will be shown if any of the following conditions are met: | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini | | `disabled` | `false` | Disables the `python` module. | -::: 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. - -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. - -::: +> [!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. +> +> 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. ### Variabel @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opsi @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opsi | Opsi | Bawaan | Deskripsi | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opsi @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opsi @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `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. | -| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | -| `detect_folders` | `['.terraform']` | Folder mana yang sebaiknya memicul modul ini. | -| `style` | `'bold 105'` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `terraform` module. | +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `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. | +| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | +| `detect_folders` | `['.terraform']` | Folder mana yang sebaiknya memicul modul ini. | +| `style` | `'bold 105'` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variabel @@ -4436,7 +4449,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Waktu 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opsi @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Opsi @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: + +- Direktori ini memiliki berkas `xmake.lua` + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. | +| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | Simbol yang digunakan sebelum versi cmake. | +| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini | +| `detect_files` | `['xmake.lua']` | filenames mana yang sebaiknya memicu modul ini | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini | +| `style` | `'bold green'` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v2.9.5` | The version of xmake | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Opsi @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Contoh diff --git a/docs/id-ID/guide/README.md b/docs/id-ID/guide/README.md index 4a9899cdb..a37d25e96 100644 --- a/docs/id-ID/guide/README.md +++ b/docs/id-ID/guide/README.md @@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ Jika kamu ingin mengkustomisasi Starship lebih jauh: ## 🤝 Berkontribusi -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). +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"). 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/). diff --git a/docs/id-ID/presets/README.md b/docs/id-ID/presets/README.md index 5de010e00..22569ec9e 100644 --- a/docs/id-ID/presets/README.md +++ b/docs/id-ID/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/id-ID/presets/catppuccin-powerline.md b/docs/id-ID/presets/catppuccin-powerline.md index 40e03b34d..afb0b84b4 100644 --- a/docs/id-ID/presets/catppuccin-powerline.md +++ b/docs/id-ID/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/id-ID/presets/pure-preset.md b/docs/id-ID/presets/pure-preset.md index eeb1a8daf..705c788b6 100644 --- a/docs/id-ID/presets/pure-preset.md +++ b/docs/id-ID/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/id-ID/presets/tokyo-night.md b/docs/id-ID/presets/tokyo-night.md index b82d4bcfc..03954a68c 100644 --- a/docs/id-ID/presets/tokyo-night.md +++ b/docs/id-ID/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/it-IT/README.md b/docs/it-IT/README.md index a1e490555..65c6bfb4e 100644 --- a/docs/it-IT/README.md +++ b/docs/it-IT/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md index c83e8086b..0ddbe80ee 100644 --- a/docs/it-IT/advanced-config/README.md +++ b/docs/it-IT/advanced-config/README.md @@ -2,11 +2,7 @@ Nonostante Starship sia una shell versatile, a volte devi fare qualche modifica in più in `starship.toml` per ottenere alcune cose. Questa pagina descrive alcune tecniche di configurazione avanzate utilizzate in Starship. -::: warning - -Le configurazioni in questa sezione sono soggette a modifiche nelle future versioni di Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt su PowerShell diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index 2337406ee..a4b6b505f 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Esempio @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Variable | Default | Descrizione | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Esempio @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Esempio @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Opzioni @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Opzioni @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `'blu grassetto'` | Lo stile per il modulo. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Opzione | Default | Descrizione | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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` | `'blu grassetto'` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Opzioni @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | Lo stile per il modulo. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `['fpm.toml']` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opzioni @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Opzioni @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Opzioni @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Esempio +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Opzioni -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Opzione | Default | Descrizione | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opzioni @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | Lo stile per il modulo. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | Lo stile per il modulo. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Quali estensioni dovrebbero attivare questo modulo. | -| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | -| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opzioni @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Opzioni @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. | | `version_format` | `'v${raw}'` | Il formato della versione. Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | The symbol used before the environment name. | -| `style` | `'yellow bold' | Lo stile per il modulo. | +| `style` | `'yellow bold'` | Lo stile per il modulo. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_files` | `['pixi.toml']` | Quali nomi di file dovrebbero attivare questo modulo. | -| `detect_folders` | `['.pixi']` | Quali cartelle dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ By default, the module will be shown if any of the following conditions are met: | `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo | | `disabled` | `false` | Disables the `python` module. | -::: 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. - -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. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opzioni @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Opzioni | Opzione | Default | Descrizione | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opzioni @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opzioni @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Quali estensioni dovrebbero attivare questo modulo. | -| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | -| `detect_folders` | `['.terraform']` | Quali cartelle dovrebbero attivare questo modulo. | -| `style` | `'bold 105'` | Lo stile per il modulo. | -| `disabled` | `false` | Disables the `terraform` module. | +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `['.terraform']` | Quali cartelle dovrebbero attivare questo modulo. | +| `style` | `'bold 105'` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Ora 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Opzioni @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Opzioni @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo | +| `detect_files` | `['xmake.lua']` | Quali nomi di file dovrebbero attivare questo modulo | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo | +| `style` | `'bold green'` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Opzioni @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Esempio diff --git a/docs/it-IT/guide/README.md b/docs/it-IT/guide/README.md index 8c9913e1c..ebdfaf760 100644 --- a/docs/it-IT/guide/README.md +++ b/docs/it-IT/guide/README.md @@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ 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). +Siamo sempre alla ricerca di collaboratori di **tutti i livelli**! 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/). diff --git a/docs/it-IT/presets/README.md b/docs/it-IT/presets/README.md index 6721e29fa..cd645ee1e 100644 --- a/docs/it-IT/presets/README.md +++ b/docs/it-IT/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/it-IT/presets/catppuccin-powerline.md b/docs/it-IT/presets/catppuccin-powerline.md index 13a98aae9..56668057b 100644 --- a/docs/it-IT/presets/catppuccin-powerline.md +++ b/docs/it-IT/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/it-IT/presets/pure-preset.md b/docs/it-IT/presets/pure-preset.md index 11f25e69f..5367a24e5 100644 --- a/docs/it-IT/presets/pure-preset.md +++ b/docs/it-IT/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/it-IT/presets/tokyo-night.md b/docs/it-IT/presets/tokyo-night.md index 4a89be968..15128f23c 100644 --- a/docs/it-IT/presets/tokyo-night.md +++ b/docs/it-IT/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index 41c59a954..4c9d4d414 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - elvish v0.18 以降のみサポートされます。 - - ::: - - `~/.elvish/rc.elv` の最後に以下を追記してください。 + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - これは将来的に変更される可能性があります。 Nushell v0.96+ のみサポートされています。 - - ::: + > [!WARNING] This will change in the future. Nushell v0.96+ のみサポートされています。 Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/ja-JP/advanced-config/README.md b/docs/ja-JP/advanced-config/README.md index 1829cab42..ad07cc6d4 100644 --- a/docs/ja-JP/advanced-config/README.md +++ b/docs/ja-JP/advanced-config/README.md @@ -2,11 +2,7 @@ Starship は汎用性の高いシェルですが、時には特定の処理を行うために `starship.toml` を編集する以上のことをする必要があります。 このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。 -::: warning - -ここに載せられた設定は、Starship の将来のリリースで変更される可能性があります。 - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## PowerShell の TransientPrompt @@ -251,7 +247,7 @@ right_format = """$all""" 一部のシェルは、通常のプロンプトの他に継続プロンプトをサポートしています。 このプロンプトは、ユーザーが不完全な文 (単一の左括弧や引用符など) を確定したときに通常のプロンプトの代わりに表示されます。 -Starship では、 `contination_prompt` オプションを使用して継続プロンプトを設定できます。 既定の継続プロンプトは `'[・](bright-black) '` です。 +Starship では、 `contination_prompt` オプションを使用して継続プロンプトを設定できます。 既定の継続プロンプトは `'[∙](bright-black) '` です。 注意: `contination_prompt` には変数を含まないそのまま文字列を設定する必要があります。 diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index 3ebe5e30f..2ef083757 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -208,11 +208,7 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts'] | `palettes` | `{}` | [色](../advanced-config/#style-strings) をユーザー定義の色名に割り当てる配色のコレクション。 ※配色で自身の色定義を参照することはできません。 | | `follow_symlinks` | `true` | ディレクトリかどうかをチェックするためにシンボリックリンクをたどります。git などのモジュールで使われます。 | -::: tip - -ネットワーク上のファイルシステムへのシンボリックリンクがある場合は、 `follow_symlinks` を `false` に設定することを検討してください。 - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### 設定例 @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' `azure` モジュールは、現在のAzureサブスクリプションを表示します。 これは、 `~/.azure/azureProfile.json` ファイルで定義されているデフォルトのサブスクリプション名またはユーザー名の表示に基づいています。 +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | 変数 | デフォルト | 説明 | @@ -658,15 +658,13 @@ format = 'via [🍔 $version](bold green) ' | symbol | | オプション `symbol` の値をミラーする | | style | | オプション `style` の値をミラーする | -`version`はデフォルトのフォーマットではないことに注意してください。 - ### Commands `commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。 各コマンドは、実行可能ファイル名 (とそれに続く引数) のリストで表現されます。通常は`['mycc', '--version']`のようになります。 StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。 -もし、Cコンパイラがこのモジュールでサポートされていない場合は、[GitHubで問題を提起する](https://github.com/starship/starship/)ことでリクエストできます。 +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### 設定例 @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | オプション `symbol` の値をミラーする | | style | | オプション `style` の値をミラーする | -`version`はデフォルトのフォーマットではないことに注意してください。 - ### Commands `commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。 Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。 -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### 設定例 @@ -735,11 +733,7 @@ characterは、最後のコマンドが成功したかどうかを示します デフォルトでは、色だけが変更されます。 形も変えてみたい場合は[このサンプル](#with-custom-error-shape)も参考にしてください。 -::: warning - -`vimcmd_symbol`はcmd, fish and zshでのみサポートされています。 `vimcmd_replace_one_symbol`、`vimcmd_replace_symbol`と`vimcmd_visual_symbol`は、[zshでのモード検出による問題](https://github.com/starship/starship/issues/625#issuecomment-732454148)のため、fishでのみサポートされています。 - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### オプション @@ -855,13 +849,11 @@ vimcmd_symbol = '[V](bold green) ' `cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 -::: warning BashでDEBUGトラップをhookしない +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -`bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。 - -::: - -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). `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。 ### オプション @@ -897,13 +889,9 @@ format = 'underwent [$duration](bold yellow)' ## Conda -`conda` モジュールは、`$CONDA_DEFAULT_ENV` が設定されている場合、現在の[Conda](https://docs.conda.io/en/latest/) 環境を表示します。 +The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. -::: tip - -Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### オプション @@ -970,7 +958,7 @@ 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/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`shard.yml`ファイルが含まれている - カレントディレクトリに`.cr`の拡張子のファイルが含まれている @@ -1009,7 +997,7 @@ format = 'via [✨ $version](bold blue) ' ## Daml -`daml`モジュールは、Damlプロジェクトのルートディレクトリにいるときに、使用している[Daml](https://www.digitalasset.com/developers) SDKバージョンを表示します。 環境変数`DAML_SDK_VERSION`を上書きしない限り、`daml.yaml`ファイルの`sdk-version`が使用されます。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. 環境変数`DAML_SDK_VERSION`を上書きしない限り、`daml.yaml`ファイルの`sdk-version`が使用されます。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`daml.yaml`ファイルが含まれている @@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) ' ## Dart -`dart`モジュールは、現在インストールされている[Dart](https://dart.dev/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`.dart`の拡張子のファイルが含まれている - カレントディレクトリに`.dart_tool`ディレクトリが含まれている @@ -1087,7 +1075,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/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' `direnv` モジュールは、もし存在すれば、現在の rc ファイルの状態を示します。 状態として rc ファイルへのパス、ロードされているかどうか、および `direnv` によって許可されているかどうかを含みます。 +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -1251,16 +1241,16 @@ 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` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | どんなファイル名がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | -| `detect_folders` | `[]` | どんなフォルダがこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | -| `style` | `'blue bold'` | モジュールのスタイルです。 | -| `disabled` | `false` | `docker_context`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | module のフォーマットです。 | +| `symbol` | `'🐳 '` | Dockerコンテキストを表示する前に使用される記号です。 | +| `only_with_files` | `true` | ファイルに一致する場合にのみ表示 | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | +| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | どんなファイル名がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | +| `detect_folders` | `[]` | どんなフォルダがこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | +| `style` | `'blue bold'` | モジュールのスタイルです。 | +| `disabled` | `false` | `docker_context`モジュールを無効にします。 | ### 変数 @@ -1426,26 +1416,17 @@ format = 'via [ $version](cyan bold) ' - `variable`オプションが、既存の環境変数と一致する - `variable`オプションが定義されておらず、`default`オプションが定義されている -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). 既定では、 `env_var` モジュールは、単にすべての env_var モジュールを定義順で表示します。 -env_var モジュールが表示される順序は、`${env_var.foo}` (ドットが含まれるので `${...}` を使う必要があります) をトップレベルの `format` に入れることで個別に設定できます。 既定では、 `env_var` モジュールは、単にすべての env_var モジュールを定義順で表示します。 - -::: - -::: tip - -`.`を使うことで複数の環境変数を表示することができます。 (例を確認してみてください) `variable`が設定されていない場合、このモジュールは`.`以降に書かれている環境変数の値を表示します。 - -例: 次の設定ではUSER環境変数を表示します。 - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!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. +> +> 例: 次の設定ではUSER環境変数を表示します。 +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### オプション @@ -1596,10 +1577,49 @@ style = 'bold green' AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| `symbol` | `' '` | COBOLのバージョンを表示する前に使用される記号です。 | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `version_format` | `'${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `style` | `'bold purple'` | モジュールのスタイルです。 | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `['fpm.toml']` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | コンパイラを検出する方法 | +| `disabled` | `false` | Disables the `fortran` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | ----------------------------------- | +| name | gfortran | コンパイラ名 | +| version | `14.2.0` | The version of the Fortran compiler | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + +### Commands + +`commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。 + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。 + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch `fossil_branch`モジュールは、現在のディレクトリにあるチェックアウトのアクティブなブランチ名を表示します。 +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -1636,6 +1656,8 @@ truncation_symbol = '' `fossil_branch` モジュールは、現在のディレクトリのチェックアウトにおける追加・削除された行数を表示します。 少なくとも Fossil バージョン 2.14 (2021-01-20) が必要です。 +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -1759,6 +1781,7 @@ very-long-project-name = 'vlpn' | `truncation_symbol` | `'…'` | ブランチ名が切り捨てられていることを示すための記号です。 `''` で記号なしにできます。 | | `only_attached` | `false` | デタッチ `HEAD` 状態にない時はブランチ名のみ表示します。 | | `ignore_branches` | `[]` | 表示しない名前のリスト。 'master' や 'main' に対して有用です。 | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | `git_branch`モジュールを無効にします。 | ### 変数 @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' `git_metrics` モジュールは、現在の git リポジトリにおける追加・削除された行数を表示します。 -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 ### オプション @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' `git_status` モジュールは、カレントディレクトリのリポジトリの状態を表すシンボルを表示します。 -::: tip - -WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Statusモジュールは動作が非常に遅いです。 モジュールを無効にするか、`windows_starship`オプションを使用することで、WindowsネイティブのStarshipを使用し、対象の`git_status`を計算できます。 - -::: +> [!TIP] The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. モジュールを無効にするか、`windows_starship`オプションを使用することで、WindowsネイティブのStarshipを使用し、対象の`git_status`を計算できます。 ### オプション @@ -1925,7 +1940,7 @@ WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Status | `diverged` | `'⇕'` | `diverged`のフォーマット | | `up_to_date` | `''` | `up_to_date`のフォーマット | | `untracked` | `'?'` | `untracked`のフォーマット | -| `stashed` | `'$'` | `stashed`のフォーマット | +| `stashed` | `'\$'` | `stashed`のフォーマット | | `modified` | `'!'` | `modified`のフォーマット | | `staged` | `'+'` | `staged`のフォーマット | | `renamed` | `'»'` | `renamed`のフォーマット | @@ -2119,10 +2134,10 @@ format = 'via [$symbol($version )($mod_version )]($style)' ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --- | ----------------------- | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --- | ------------------------- | +| symbol | | オプション `symbol` の値をミラーします。 | +| style\* | | オプション `style` の値をミラーします。 | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2163,11 +2178,11 @@ format = 'via [🐂](yellow bold) ' ### 変数 -| 変数 | 設定例 | 説明 | -| ------- | -------- | ------------------------- | -| version | `v7.5.1` | `gradle`のバージョン | -| symbol | | オプション `symbol` の値をミラーします。 | -| style* | | オプション `style` の値をミラーします。 | +| 変数 | 設定例 | 説明 | +| ------- | -------- | ----------------------- | +| version | `v7.5.1` | `gradle`のバージョン | +| symbol | | オプション `symbol` の値をミラーする | +| style* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2227,11 +2242,11 @@ format = 'via [🐂](yellow bold) ' ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------- | ----------------------- | -| version | `v4.2.5` | `haxe` のバージョン | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------- | ------------------------ | +| version | `v4.2.5` | `haxe` のバージョン | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーします。 | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2266,11 +2281,11 @@ format = "via [⌘ $version](bold fg:202) " ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------- | ------------------------ | -| version | `v3.1.1` | `helm` のバージョン | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーします。 | +| 変数 | 設定例 | 説明 | +| --------- | -------- | ----------------------- | +| version | `v3.1.1` | `helm` のバージョン | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2392,17 +2407,9 @@ symbol = '🌟 ' - 1個のジョブ -> `symbol` を表示します。 - 2個以上のジョブ-> `symbol` + `number` を表示します。 -::: warning +> [!WARNING] This module is not supported on tcsh. -このモジュールは tcsh と nu ではサポートされません。 - -::: - -::: warning - -オプション `threshold` は非推奨になりましたが、`threshold` が指定されている場合には、モジュールは走っているジョブの数を表示します。 `threshold` が 0 に設定されている場合は、ジョブが走っていない場合にもモジュールが表示されます。 - -::: +> [!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. ### オプション @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia `julia`モジュールは、現在インストールされている[Julia](https://julialang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 @@ -2489,7 +2504,7 @@ symbol = '∴ ' | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `format` | `'via [$symbol($version )]($style)'` | モジュールのフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `detect_extensions` | `['kt', 'kts']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | @@ -2530,26 +2545,18 @@ kotlin_binary = 'kotlinc' 現在の[Kubernetes コンテキスト](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context)名を表示します。 kubeconfigファイルに設定されている場合は、名前空間、ユーザー、クラスターも表示します。 名前空間は kubeconfig ファイルの中で設定する必要があります。次のようにして行います: `kubectl config set-context starship-context --namespace astronaut`。 同様に、ユーザーとクラスターは `kubectl config set-context starship-context --user starship-user` と `kubectl config set-context starship-context ---cluster starship-cluster` で設定できます。 環境変数 `$KUBECONFIG` が設定されている場合、このモジュールはそれを利用し、 `~/.kube/config` を利用しません。 -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -モジュールが有効化されているとき、`detect_env_vars`, `detect_extensions`, `detect_files`, `detect_folders` の何れかのオプションが設定されていない限りモジュールは常に表示されます。これらのオプションが設定されている場合は、対応する条件が満たされるディレクトリ内にいるときまたは環境変数が存在するときに、モジュールが表示されます。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### オプション -::: warning - -`context_aliases` と `user_aliases` オプションは非推奨になりました。 代わりに `contexts` と対応するオプション `context_alias` と `user_alias` をお使いください。 - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | オプション | デフォルト | 説明 | | ------------------- | ---------------------------------------------------- | ------------------------------- | | `symbol` | `'☸ '` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | モジュールのフォーマットです。 | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | | `style` | `'cyan bold'` | モジュールのスタイルです。 | | `context_aliases`* | `{}` | 表示するコンテキストエイリアスを定義するテーブル。 | | `user_aliases`* | `{}` | 表示するユーザーエイリアスを定義するテーブル。 | @@ -2666,6 +2673,8 @@ disabled = true `localip`モジュールは、プライマリネットワークインターフェイスのIPv4アドレスを表示します。 +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -2742,11 +2751,7 @@ format = 'via [🌕 $version](bold blue) ' デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。 -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 ### オプション @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + +### オプション + +| オプション | デフォルト | 説明 | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | `merge`進行中に表示されるフォーマット文字列です。 | +| `rebase` | `'REBASING'` | `rebase`進行中に表示されるフォーマット文字列です。 | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | `bisect`進行中に表示されるフォーマット文字列です。 | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | モジュールのスタイルです。 | +| `format` | `'\([$state]($style)\) '` | module のフォーマットです。 | +| `disabled` | `true` | Disables the `hg_state` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| ---------------- | ---------- | ---------------------- | +| state | `REBASING` | 現在のリポジトリの状態 | +| progress_current | `1` | 現在の進行状態 | +| progress_total | `2` | 全体の進行状態 | +| style\* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ---------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | Zig のバージョンの前に表示されるシンボルです。 | -| `style` | `'bold bright-blue'` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | ### 変数 @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 ### オプション @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## パッケージのバージョン -`package` モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +`package` モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ Arch = "Arch is the best! " - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### オプション @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | module のフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | 環境名の直前に使用されるシンボルです。 | -| `style` | `'yellow bold' | モジュールのスタイルです。 | +| `style` | `'yellow bold'` | モジュールのスタイルです。 | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['pixi.toml']` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `['.pixi']` | どのフォルダーがこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `disabled` | `false` | Disables the `pixi` module. | ### 変数 @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). それでも有効にしたい場合は、 [以下の例に従ってください](#with-pulumi-version). - -::: +> [!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). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 @@ -3712,13 +3742,9 @@ The `python` module shows the currently installed version of [Python](https://ww | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `disabled` | `false` | `python`モジュールを無効にします。 | -::: tip - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -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. - -::: +> [!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. +> +> 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. ### 変数 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 ### オプション @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 + ### オプション | オプション | デフォルト | 説明 | @@ -4153,8 +4177,8 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu | 変数 | 設定例 | 説明 | | --------- | ------------ | ----------------------------- | | env | `centos.img` | The current Singularity image | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| symbol | | オプション `symbol` の値をミラーします | +| style\* | | オプション `style` の値をミラーします | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -4192,7 +4216,7 @@ The `solidity` module shows the currently installed version of [Solidity](https: | 変数 | 設定例 | 説明 | | --------- | -------- | ------------------------- | | version | `v0.8.1` | The version of `solidity` | -| symbol | | オプション `symbol` の値をミラーします | +| symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -4225,7 +4249,7 @@ format = "via [S $version](blue bold)" | ----------- | ------------ | ----------------------- | | environment | `astronauts` | 現在の spack 環境 | | symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーします | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' `status` モジュールは、直前のコマンドの終了ステータスを表示します。 $success_symbol が空 (既定) の場合、モジュールは終了ステータスが `0` でない場合にのみ表示されます。 終了ステータスは符号付き32ビット整数にキャストされます。 -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 ### オプション @@ -4305,11 +4325,7 @@ disabled = false `sudo` モジュールは、sudo 資格情報が現在キャッシュされているかどうかを表示します。 モジュールは資格情報がキャッシュされている場合にのみ表示されます。 -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 ### オプション @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 +`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 It supports both Hashicorp Terraform and OpenTofu for version detection. -::: tip - -Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 @@ -4406,16 +4418,17 @@ Terraformのバージョンはデフォルトでは表示されません。多 ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `'via [$symbol$workspace]($style) '` | モジュールのフォーマット文字列。 | -| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'💠'` | ワークスペースの前に表示されるフォーマット文字列。 | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `['.terraform']` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `'bold 105'` | モジュールのスタイルです。 | -| `disabled` | `false` | `terraform` モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------ | +| `format` | `'via [$symbol$workspace]($style) '` | モジュールのフォーマット文字列。 | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `'💠'` | ワークスペースの前に表示されるフォーマット文字列。 | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `['.terraform']` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `'bold 105'` | モジュールのスタイルです。 | +| `disabled` | `false` | `terraform` モジュールを無効にします。 | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### 変数 @@ -4436,7 +4449,7 @@ Terraformのバージョンはデフォルトでは表示されません。多 # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Terraform バージョン表示なし @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## 時刻 `time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 -::: tip - -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 - -::: +> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。 ### オプション @@ -4537,11 +4546,7 @@ time_range = '10:00:00-14:00:00' - `show_always`変数がtrueに設定されている - 配列 `detect_env_var` に、少なくとも1つの現在シェルで設定されている環境変数の名前が含まれている -::: tip - -SSH接続は、環境変数 `SSH_CONNECTION`、 `SSH_CLIENT`、および `SSH_TTY` をチェックすることで検出されます。 お使いの SSH ホストがこれらの変数を設定しない場合、回避策として例えばこれらの変数にダミー値を設定してください。 - -::: +> [!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. ### オプション @@ -4684,6 +4689,35 @@ format = 'via [V $version](blue bold) ' format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). デフォルトでは次のいずれかの条件が満たされると、モジュールがアクティブになります。 + +- 現在のディレクトリに`xmake.lua`ファイルが含まれている + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `'△ '` | cmakeのバージョンの前に使用される記号 | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `['xmake.lua']` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `'bold green'` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `xmake` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | ----------------------- | +| version | `v2.9.5` | The version of xmake | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + ## Zig 既定で `zig`モジュールは、現在インストールされている[Zig](https://ziglang.org/)のバージョンを表示します。 このモジュールは次の条件のいずれかが満たされると表示されます: @@ -4734,31 +4768,17 @@ symbol = '⚡️ ' - `when` コマンドが 0 を返す。 - `os` フィールドが指定されている場合、現在のオペレーティング システム (std::env::consts::OS) がそれに一致する。 -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -`.` を使用して複数のカスタムモジュールを定義できます。 +> [!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 `${...}`). 既定では、 `custom` モジュールは、単にすべての custom モジュールを定義順で表示します。 -::: +> [!TIP] [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. 紹介されていない興味深い用例をお持ちでしたら、そちらで気軽に共有してください! -::: tip - -カスタムモジュールが表示される順序は、`${custom.foo}` (ドットが含まれるので `${...}` を使う必要があります) をトップレベルの `format` に入れることで個別に設定できます。 既定では、 `custom` モジュールは、単にすべての custom モジュールを定義順で表示します。 - -::: - -::: tip - -[イシュー #1252](https://github.com/starship/starship/discussions/1252) にはカスタムモジュールの例が含まれています。 紹介されていない興味深い用例をお持ちでしたら、そちらで気軽に共有してください! - -::: - -::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -コマンドが生成するいかなる出力もそのままプロンプト内に表示されます。 This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -フォーマット文字列には、シェル固有のプロンプトシーケンスを含めることもできます。例えば [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> コマンドが生成するいかなる出力もそのままプロンプト内に表示されます。 This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### オプション @@ -4808,17 +4828,15 @@ The `command` (and `when`, if applicable) will be passed in on stdin. shell = ['pwsh', '-Command', '-'] ``` -::: warning 設定したカスタムシェルが正常終了することを再度ご確認ください - -カスタムコマンドを設定するときは、(`shell` オプションを通して指定される) Starship が使用する既定のシェルがコマンドを正しく実行し正しく終了することを確認してください。 - -たとえば、PowerShell では一行コマンドを実行するために `-Command` パラメータを指定する必要があります。 このパラメータを省略すると、呼び出されたシェルが初期化のために再帰的に Starship を呼び出し、その Starship が再びカスタムコマンドを実行することによって、無限ループになる可能性があります。 - -PowerShell の `-NoProfile` に似たパラメータは、他のシェルでも推奨されます。これは、Starship の呼び出しごとにカスタムプロファイルの追加ロード時間が発生することを避けるためです。 - -現在、シェルと適切なパラメータの自動検出は実装されていますが、すべてのシェルがカバーされているとは限りません。 このような状況にお気づきの場合は、[イシューを開いて](https://github.com/starship/starship/issues/new/choose)シェルの詳細と Starship の設定をご報告ください。 - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index ac3aa4dc9..5f95c43c9 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -`~/.elvish/rc.elv` の最後に以下を追記してください。 +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -注意: Elvish v0.18以降でサポートされています +注意: Elvish v0.18以降でサポートされています. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ Starshipのさらなるカスタマイズを目指すなら以下を参考にし ## 🤝 貢献 -私たちは常に**すべてのスキルレベル**の貢献者を探しています！ もし簡単にプロジェクトへ参加する方法をお探しなら、 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) に取り組んでみてください。 +私たちは常に**すべてのスキルレベル**の貢献者を探しています！ 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/) から貢献できます。 diff --git a/docs/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md index 751733bf4..1137915a1 100644 --- a/docs/ja-JP/presets/README.md +++ b/docs/ja-JP/presets/README.md @@ -14,11 +14,7 @@ このプリセットは一部のモジュールで使われるシンボルを変更して、Nerd Font シンボルをどこにも使わないようにします。 -::: tip - -このプリセットは [Starship の将来のリリース](https://github.com/starship/starship/pull/3544) でデフォルトのプリセットになります。 - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [No Nerd Font プリセットを表示するにはクリックしてください。](./no-nerd-font) diff --git a/docs/ja-JP/presets/catppuccin-powerline.md b/docs/ja-JP/presets/catppuccin-powerline.md index 7b2359b1d..b09c1f107 100644 --- a/docs/ja-JP/presets/catppuccin-powerline.md +++ b/docs/ja-JP/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[プリセット一覧に戻る](./README.md#catppuccin-powerline) +[プリセット一覧に戻る](./#catppuccin-powerline) # Catppuccin Powerline プリセット diff --git a/docs/ja-JP/presets/pure-preset.md b/docs/ja-JP/presets/pure-preset.md index ce7277b4d..64858554d 100644 --- a/docs/ja-JP/presets/pure-preset.md +++ b/docs/ja-JP/presets/pure-preset.md @@ -1,4 +1,4 @@ -[プリセット一覧に戻る](./#pure) +[プリセット一覧に戻る](./#pure-prompt) # Pureプリセット diff --git a/docs/ja-JP/presets/tokyo-night.md b/docs/ja-JP/presets/tokyo-night.md index a95f46577..d92f20947 100644 --- a/docs/ja-JP/presets/tokyo-night.md +++ b/docs/ja-JP/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[プリセット一覧に戻る](./#pastel-powerline) +[プリセット一覧に戻る](./#tokyo-night) # Tokyo Night プリセット diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md index 3f204fe4e..22c29276d 100644 --- a/docs/ko-KR/README.md +++ b/docs/ko-KR/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - elvish 버전 v0.18 이상에서만 지원됩니다. - - ::: - - `~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - 추후에 변경될 예정입니다. Nushell v0.96 버전 이상에서만 지원됩니다. - - ::: + > [!WARNING] This will change in the future. Nushell v0.96 버전 이상에서만 지원됩니다. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/ko-KR/advanced-config/README.md b/docs/ko-KR/advanced-config/README.md index 16d47ef37..d42e7f424 100644 --- a/docs/ko-KR/advanced-config/README.md +++ b/docs/ko-KR/advanced-config/README.md @@ -2,11 +2,7 @@ While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. -::: warning - -The configurations in this section are subject to change in future releases of Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index 7136ebaa7..78ab24d5e 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### 예시 @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Variable | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | 기호 | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### 예시 @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | 기호 | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### 예시 @@ -724,7 +722,7 @@ disabled = false format = 'via [$name $version]($style)' ``` -## Character +## 문자 The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -851,15 +845,13 @@ The `cobol` module shows the currently installed version of COBOL. By default, t *: This variable can only be used as a part of a style string -## Command Duration +## 명령 지속 시간 The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1121,7 +1109,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d format = 'via [🦕 $version](green bold) ' ``` -## Directory +## 디렉토리 The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the module. | -| `기호` | `'🐳 '` | 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the module. | +| `기호` | `'🐳 '` | 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1419,33 +1409,24 @@ 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 module will be shown only if any of the following conditions are met: - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `기호` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | 예시 | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 기호 | | 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1785,7 +1808,7 @@ truncation_symbol = '' ignore_branches = ['master', 'main'] ``` -## Git Commit +## Git 커밋 The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1904,15 +1923,11 @@ added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ``` -## Git Status +## Git 상태 The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2283,7 +2298,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s format = 'via [⎈ $version](bold white) ' ``` -## Hostname +## 호스트 이름 The `hostname` module shows the system hostname. @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Options @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | 예시 | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `기호` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `기호` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. | | `기호` | `'🧚 '` | The symbol used before the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). 그래도 활성화하려면, [아래에 있는 예시를 따라 하세요](#with-pulumi-version). - -::: +> [!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 module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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. 그래도 활성화하려면, [아래에 있는 예시를 따라 하세요](#with-terraform-version). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. 그래도 활성화하려면, [아래에 있는 예시를 따라 하세요](#with-terraform-version). By default the module will be shown if any of the following conditions are met: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `기호` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` -## Time +## 시간 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `기호` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | 예시 | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 기호 | | 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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/ko-KR/faq/README.md b/docs/ko-KR/faq/README.md index b2c04c796..def363e64 100644 --- a/docs/ko-KR/faq/README.md +++ b/docs/ko-KR/faq/README.md @@ -10,22 +10,22 @@ - **구성**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **프롬프트**: [Starship](https://starship.rs/) -## How do I get command completion as shown in the demo GIF? +## 데모 GIF에 표시된 명령 완성 기능을 어떻게 얻을 수 있나요? -Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). +완성 지원 또는 자동 완성은 선택한 셸에서 제공합니다. 데모의 경우 [Fish Shell](https://fishshell.com/)로 데모를 진행했으며, Fish Shell은 기본적으로 완성을 제공합니다. Z Shell(zsh)을 사용하는 경우 [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)를 살펴보는 것이 좋습니다. -## Do top level `format` and `.disabled` do the same thing? +## 최상위 `format`과 `.disabled`는 동일한 기능을 하나요? -Yes, they can both be used to disable modules in the prompt. If all you plan to do is disable modules, `.disabled` is the preferred way to do so for these reasons: +예, 둘 다 프롬프트에서 모듈을 비활성화하는 데 사용할 수 있습니다. 모듈을 비활성화하는 것이 유일한 계획이라면 다음과 같은 이유로 `.disabled`가 선호되는 방법입니다. -- Disabling modules is more explicit than omitting them from the top level `format` -- Newly created modules will be added to the prompt as Starship is updated +- 모듈 비활성화는 최상위 `format`에서 생략하는 것보다 더 명시적입니다. +- 새로 생성된 모듈은 Starship이 업데이트됨에 따라 프롬프트에 추가됩니다. ## The docs say Starship is cross-shell. Why isn't my preferred shell supported? -The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used. +Starship이 구축된 방식으로는 사실상 모든 셸에 대한 지원을 추가할 수 있어야 합니다. starship 바이너리는 상태 비저장이며 셸에 구애받지 않으므로, 셸이 프롬프트 사용자 지정을 지원하고 셸 확장을 지원하는 한 Starship을 사용할 수 있습니다. -Here's a small example getting Starship working with bash: +다음은 Starship이 bash에서 작동하는 작은 예시입니다. ```sh # Get the status code from the last command executed @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations. +Starship에 내장된 [Bash 구현](https://github.com/starship/starship/blob/master/src/init/starship.bash)은 [명령 지속 시간 모듈](https://starship.rs/config/#command-duration)과 같은 고급 기능을 허용하고 Starship이 사전 설치된 Bash 구성과 호환되도록 하기 위해 약간 더 복잡합니다. `starship 프롬프트`에서 지원하는 모든 플래그 값을 보려면 아래 명령어를 사용하세요: @@ -46,7 +46,7 @@ The [Bash implementation](https://github.com/starship/starship/blob/master/src/i starship prompt --help ``` -The prompt will use as much context as is provided, but no flags are "required". +프롬프트는 제공된 만큼의 컨텍스트를 사용하지만, "필수" 플래그는 없습니다. ## 오래된 버전의 glibc가 있는 Linux 배포판에서 Starship을 어떻게 실행하나요? @@ -58,52 +58,52 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl ## 왜 `Executing command "..." timed out.` 경고가 뜨나요? -Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](../config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings. +Starship은 프롬프트에 표시할 정보를 얻기 위해 다양한 명령을 실행합니다. 예를 들어 프로그램 버전이나 현재 git 상태를 가져옵니다. starship이 이러한 명령을 실행하는 동안 멈추지 않도록 시간 제한을 설정합니다. 명령이 이 제한보다 오래 걸리면 starship은 명령 실행을 중지하고 위 경고를 출력합니다. 이는 예상된 동작입니다. 이 시간 제한은 [`command_timeout` 키](../config/#prompt)를 사용하여 구성할 수 있으므로 원하는 경우 시간 제한을 늘릴 수 있습니다. 또한 아래 디버깅 단계를 따라 어떤 명령이 느린지 확인하고 최적화할 수 있는지 확인할 수 있습니다. 마지막으로 이러한 경고를 숨기려면 `STARSHIP_LOG` 환경 변수를 `error`로 설정할 수 있습니다. ## 이해할 수 없거나 예상치 못한 기호가 보이는데 무슨 뜻인가요? -If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules. +인식할 수 없는 기호가 보이면 `starship explain`을 사용하여 현재 표시되는 모듈을 설명할 수 있습니다. -## Starship is doing something unexpected, how can I debug it? +## Starship이 예상치 못한 동작을 하는데, 어떻게 디버깅할 수 있나요? -You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module. +`STARSHIP_LOG` 환경 변수를 사용하여 디버그 로그를 활성화할 수 있습니다. 이 로그는 매우 자세할 수 있으므로 특정 모듈을 디버깅하려는 경우 `module` 명령을 사용하는 것이 유용합니다. 예를 들어 `rust` 모듈을 디버깅하려는 경우 다음 명령을 실행하여 모듈의 추적 로그 및 출력을 얻을 수 있습니다. ```sh env STARSHIP_LOG=trace starship module rust ``` -If starship is being slow you can try using the `timings` command to see if there is a particular module or command that is to blame. +starship이 느리다면 `timings` 명령을 사용하여 특정 모듈이나 명령이 원인인지 확인할 수 있습니다. ```sh env STARSHIP_LOG=trace starship timings ``` -This will output the trace log and a breakdown of all modules that either took more than 1ms to execute or produced some output. +이것은 추적 로그와 실행하는 데 1ms 이상 걸렸거나 일부 출력을 생성한 모든 모듈의 분석을 출력합니다. -Finally if you find a bug you can use the `bug-report` command to create a GitHub issue. +마지막으로 버그를 발견하면 `bug-report` 명령을 사용하여 GitHub 이슈를 생성할 수 있습니다. ```sh starship bug-report ``` -## Why don't I see a glyph symbol in my prompt? +## 프롬프트에 글리프 기호가 보이지 않는 이유는 무엇인가요? -The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that: +가장 흔한 원인은 시스템 설정 오류입니다. 특히 일부 Linux 배포판은 기본적으로 글꼴 지원이 제공되지 않습니다. 다음 사항을 확인해야 합니다. -- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/). -- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice. -- You are using a [Nerd Font](https://www.nerdfonts.com/). +- 로케일이 `de_DE.UTF-8` 또는 `ja_JP.UTF-8`과 같은 UTF-8 값으로 설정되어 있는지 확인하세요. `LC_ALL`이 UTF-8 값이 아닌 경우 [변경해야 합니다](https://www.tecmint.com/set-system-locales-in-linux/). +- You have an emoji font installed. 대부분의 시스템에는 기본적으로 이모지 글꼴이 제공되지만, 일부(특히 Arch Linux)는 그렇지 않습니다. 일반적으로 시스템의 패키지 관리자를 통해 설치할 수 있습니다. [noto emoji](https://www.google.com/get/noto/help/emoji/)는 인기 있는 선택입니다. +- [Nerd Font](https://www.nerdfonts.com/)를 사용하고 있는지 확인하세요. -To test your system, run the following commands in a terminal: +시스템을 테스트하려면 터미널에서 다음 명령을 실행하세요. ```sh echo -e "\xf0\x9f\x90\x8d" echo -e "\xee\x82\xa0" ``` -The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). +첫 번째 줄은 [뱀 이모지](https://emojipedia.org/snake/)를 생성해야 하고, 두 번째 줄은 [파워라인 브랜치 기호(e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs)를 생성해야 합니다. -If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose) +두 기호 중 하나라도 올바르게 표시되지 않으면 시스템이 여전히 잘못 구성된 것입니다. 안타깝게도 글꼴 구성을 올바르게 설정하는 것은 때때로 어렵습니다. Discord의 사용자들이 도움을 줄 수 있습니다. 두 기호 모두 올바르게 표시되지만 starship에서 여전히 보이지 않는다면 [버그 보고서를 제출하세요!](https://github.com/starship/starship/issues/new/choose) ## Starship을 어떻게 삭제하나요? @@ -117,14 +117,13 @@ Starship을 패키지 매니저로 설치하였다면 해당 패키지 매니저 Starship을 설치 스크립트로 설치하였다면 바이너리 파일 제거를 위해 아래 명령어를 실행하세요: ```sh -# starship 바이너리 파일을 찾고 제거합니다. -sh -c 'rm "$(command -v 'starship')"' +# starship 바이너리 파일을 찾고 제거합니다. sh -c 'rm "$(command -v 'starship')"' ``` -## How do I install Starship without `sudo`? +## `sudo` 없이 Starship을 어떻게 설치하나요? -The shell install script (`https://starship.rs/install.sh`) only attempts to use `sudo` if the target installation directory is not writable by the current user. The default installation directory is the value of the `$BIN_DIR` environment variable or `/usr/local/bin` if `$BIN_DIR` is not set. If you instead set the installation directory to one that is writable by your user, you should be able to install starship without `sudo`. For example, `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin` uses the `-b` command line option of the install script to set the installation directory to `~/.local/bin`. +셸 설치 스크립트(`https://starship.rs/install.sh`)는 대상 설치 디렉토리가 현재 사용자가 쓸 수 없는 경우에만 `sudo`를 사용하려고 시도합니다. 예를 들어, `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin`은 설치 스크립트의 `-b` 명령줄 옵션을 사용하여 설치 디렉토리를 `~/.local/bin`으로 설정합니다. 기본 설치 디렉토리는 `$BIN_DIR` 환경 변수의 값 또는 `$BIN_DIR`이 설정되지 않은 경우 `/usr/local/bin`입니다. 대신 설치 디렉토리를 사용자가 쓸 수 있는 디렉토리로 설정하면 `sudo` 없이 starship을 설치할 수 있습니다. -For a non-interactive installation of Starship, don't forget to add the `-y` option to skip the confirmation. Check the source of the installation script for a list of all supported installation options. +Starship의 비대화형 설치의 경우 확인을 건너뛰려면 `-y` 옵션을 추가하는 것을 잊지 마세요. 지원되는 모든 설치 옵션 목록은 설치 스크립트의 소스를 확인하세요. -When using a package manager, see the documentation for your package manager about installing with or without `sudo`. +패키지 관리자를 사용하는 경우 `sudo`를 사용하거나 사용하지 않고 설치하는 방법에 대한 패키지 관리자 문서를 참조하세요. diff --git a/docs/ko-KR/guide/README.md b/docs/ko-KR/guide/README.md index d899cac97..ae64d358c 100644 --- a/docs/ko-KR/guide/README.md +++ b/docs/ko-KR/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo 패키지](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux 패키지](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -`~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -알림: Elvish v0.18 버전 이상에서만 지원됩니다. +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ Starship을 추가로 커스터마이징 하고싶다면: ## 🤝 기여하기 -우리는 언제나 **기술 수준에 관계없이** 기여자를 찾고 있습니다! 프로젝트에 참여하고자 한다면, [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) 를 보내보세요. +우리는 언제나 **기술 수준에 관계없이** 기여자를 찾고 있습니다! 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/) 에서 기여할 수 있습니다. diff --git a/docs/ko-KR/installing/README.md b/docs/ko-KR/installing/README.md index 6b503ea5d..d2b2af695 100644 --- a/docs/ko-KR/installing/README.md +++ b/docs/ko-KR/installing/README.md @@ -3,17 +3,17 @@ Starship을 설치하려면 다음 두 가지를 수행해주세요 1. **Starship** 바이너리를 당신의 컴퓨터에 받으세요 -1. Tell your shell to use the starship binary as its prompt by modifying its init scripts +1. 셸의 초기화 스크립트를 수정하여 starship 바이너리를 프롬프트로 사용하도록 셸에 지시하세요. -For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. +대부분의 사용자에게는 [메인 페이지](../guide/#🚀-installation)의 지침이 잘 작동할 것입니다. 그러나 일부 더 전문화된 플랫폼의 경우 다른 지침이 필요합니다. -There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! +너무 많은 플랫폼이 있어서 메인 README.md 파일에 모두 포함할 수 없었으므로, 다음은 커뮤니티에서 제공하는 다른 플랫폼에 대한 설치 지침입니다. Is yours not here? Please do add it here if you figure it out! ## [Chocolatey](https://chocolatey.org) ### 준비 사항 -Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. +[Chocolatey 설치 페이지](https://chocolatey.org/install)로 이동하여 Chocolatey 설치 지침을 따르세요. ### 설치 @@ -39,7 +39,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ### 설치 -On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: +Funtoo Linux에서는 Portage를 통해 [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship)에서 starship을 설치할 수 있습니다. ```sh emerge app-shells/starship @@ -55,9 +55,9 @@ emerge app-shells/starship nix-env -iA nixos.starship ``` -#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager) +#### 선언형, 단일 사용자, [home-manager](https://github.com/nix-community/home-manager)를 통해 -Enable the `programs.starship` module in your `home.nix` file, and add your settings +`home.nix` 파일에서 `programs.starship` 모듈을 활성화하고 설정을 추가하세요. ```nix { @@ -78,15 +78,15 @@ Enable the `programs.starship` module in your `home.nix` file, and add your sett } ``` -then run +그런 다음 실행하세요. ```sh home-manager switch ``` -#### Declarative, system-wide, with NixOS +#### 선언형, 시스템 전체, NixOS 사용 -Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run +`configuration.nix` 파일의 `environment.systemPackages`에 `pkgs.starship`을 추가한 다음 실행하세요. ```sh sudo nixos-rebuild switch diff --git a/docs/ko-KR/migrating-to-0.45.0/README.md b/docs/ko-KR/migrating-to-0.45.0/README.md index 3886acc55..8a5c18907 100644 --- a/docs/ko-KR/migrating-to-0.45.0/README.md +++ b/docs/ko-KR/migrating-to-0.45.0/README.md @@ -1,16 +1,16 @@ -# Migrating to v0.45.0 +# v0.45.0으로 마이그레이션 -Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization. +Starship v0.45.0은 대규모 v1.0.0을 준비하기 위한 주요 변경 사항이 포함된 릴리스입니다. 더 높은 수준의 사용자 정의를 허용하기 위해 프롬프트에서 구성이 수행되는 방식에 대한 몇 가지 주요 변경 사항을 적용했습니다. -This guide is intended to walk you through the breaking changes. +이 가이드는 주요 변경 사항을 안내하기 위한 것입니다. -## `prompt_order` has been replaced by a root-level `format` +## `prompt_order`가 최상위 `format`으로 대체되었습니다. -Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship. +v0.45.0 이전에는 `prompt_order`가 Starship에서 렌더링되어야 하는 순서대로 모듈 이름 배열을 허용했습니다. -Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves. +Starship v0.45.0은 대신 `format` 값을 허용하여 모듈 자체 외부에서 프롬프트를 사용자 정의할 수 있습니다. -**Example pre-v0.45.0 configuration** +**v0.45.0 이전 구성 예시** ```toml prompt_order = [ @@ -31,10 +31,10 @@ prompt_order = [ ] ``` -**Example v0.45.0 configuration** +**v0.45.0 구성 예시** ```toml -format = """\ +format = """ $username\ $hostname\ $directory\ @@ -52,40 +52,40 @@ format = """\ """ ``` -## Module `prefix` and `suffix` have been replaced by `format` +## 모듈 `prefix` 및 `suffix`가 `format`으로 대체되었습니다. -Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered. +v0.45.0 이전에는 일부 모듈이 모듈이 렌더링되는 방식을 스타일링하기 위해 `prefix` 및/또는 `suffix`를 허용했습니다. -Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output. +Starship v0.45.0은 대신 `format` 값을 허용하여 모듈이 렌더링되는 방식을 더욱 사용자 정의할 수 있습니다. 컨텍스트 기반 변수에 대한 접두사 및 접미사를 정의하는 대신, 이제 변수를 모듈의 출력을 나타내는 형식 문자열 내에서 대체할 수 있습니다. -**Example pre-v0.45.0 configuration** +**v0.45.0 이전 구성 예시** ```toml [cmd_duration] prefix = "took " ``` -**Example v0.45.0 configuration** +**v0.45.0 구성 예시** ```toml [cmd_duration] -# $duration – The command duration (e.g. "15s") -# $style – The default style of the module (e.g. "bold yellow") +# $duration – 명령 지속 시간 (예: "15s") +# $style – 모듈의 기본 스타일 (예: "bold yellow") format = "took [$duration]($style) " ``` -### Affected Modules +### 영향을 받는 모듈 -#### Character +#### 문자 -| Removed Property | Replacement | +| 제거된 속성 | 대체 | | ----------------------- | ---------------- | | `기호` | `success_symbol` | | `use_symbol_for_status` | `error_symbol` | | `style_success` | `success_symbol` | | `style_failure` | `error_symbol` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [character] @@ -98,26 +98,26 @@ format = "took [$duration]($style) " ++ vicmd_symbol = "[❮](bold green)" ``` -Previously, the `use_symbol_for_status` property was used to configure the prompt to show the `error_symbol` when the last command resulted in a non-zero status code. +이전에는 `use_symbol_for_status` 속성이 마지막 명령이 0이 아닌 상태 코드를 반환했을 때 `error_symbol`을 표시하도록 프롬프트를 구성하는 데 사용되었습니다. -With the release of v0.45.0, we now always use `error_symbol` after non-zero status codes, unifying `use_symbol_for_status` and `error_symbol` properties. +v0.45.0 릴리스에서는 이제 0이 아닌 상태 코드 후에 항상 `error_symbol`을 사용하여 `use_symbol_for_status` 및 `error_symbol` 속성을 통합합니다. -To configure the prompt to use the older `use_symbol_for_status = true` configuration, add the following to your config file: +이전 `use_symbol_for_status = true` 구성을 사용하도록 프롬프트를 구성하려면 구성 파일에 다음을 추가하세요. ```toml [character] error_symbol = "[✖](bold red)" ``` -_Note:_ The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples. +_참고:_ `character` 요소는 자동으로 뒤에 공백을 추가하므로 다른 `format` 문자열과 달리 위 예시에서는 특별히 추가하지 않습니다. -#### Command Duration +#### 명령 지속 시간 -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | +| 제거된 속성 | 대체 | +| -------- | -------- | +| `prefix` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [cmd_duration] @@ -125,13 +125,13 @@ _Note:_ The `character` element automatically adds a space after, so unlike the ++ format = "took [$duration]($style) " ``` -#### Directory +#### 디렉토리 -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | +| 제거된 속성 | 대체 | +| -------- | -------- | +| `prefix` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [directory] @@ -139,14 +139,14 @@ _Note:_ The `character` element automatically adds a space after, so unlike the ++ format = "[$path]($style)[$read_only]($read_only_style) " ``` -#### Environment Variable +#### 환경 변수 -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| 제거된 속성 | 대체 | +| -------- | -------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [env_var] @@ -155,45 +155,45 @@ _Note:_ The `character` element automatically adds a space after, so unlike the ++ format = "with [$env_value]($style) " ``` -#### Git Commit +#### Git 커밋 -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| 제거된 속성 | 대체 | +| -------- | -------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [git_commit] -- prefix = "(" -- suffix = ")" -++ format = '[\($hash\)]($style) ' +++ format = '[\]($hash\)]($style) ' ``` -#### Git Status +#### Git 상태 -| Removed Property | Replacement | -| ----------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | -| `show_sync_count` | `format` | +| 제거된 속성 | 대체 | +| ----------------- | -------- | +| `prefix` | `format` | +| `suffix` | `format` | +| `show_sync_count` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [git_status] -- prefix = "[" -- suffix = "]" -- show_sync_count = false -++ format = '([\[$all_status$ahead_behind\]]($style) )' +++ format = '([\\\[$all_status$ahead_behind\\\]]($style) )' ``` -Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch. +이전에는 `show_sync_count` 속성이 브랜치가 원격 브랜치보다 앞서거나 뒤처진 커밋 수를 표시하도록 프롬프트를 구성하는 데 사용되었습니다. -With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`. +v0.45.0 릴리스에서는 이를 `ahead`, `behind`, `diverged`의 세 가지 개별 속성으로 대체했습니다. -To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file: +이전 `show_sync_count = true` 구성을 사용하도록 프롬프트를 구성하려면 구성 파일에 다음을 설정하세요. ```toml [git_status] @@ -202,14 +202,14 @@ diverged = "⇕⇡${ahead_count}⇣${behind_count}" behind = "⇣${count}" ``` -#### Hostname +#### 호스트 이름 -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| 제거된 속성 | 대체 | +| -------- | -------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [hostname] @@ -220,28 +220,28 @@ behind = "⇣${count}" #### Singularity -| Removed Property | Replacement | -| ---------------- | ----------- | -| `label` | `format` | -| `prefix` | `format` | -| `suffix` | `format` | +| 제거된 속성 | 대체 | +| -------- | -------- | +| `label` | `format` | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [singularity] -- prefix = "" -- suffix = "" -++ format = '[$symbol\[$env\]]($style) ' +++ format = '[$symbol\\\[$env\\\]]($style) ' ``` -#### Time +#### 시간 -| Removed Property | Replacement | -| ---------------- | ------------- | -| `format` | `time_format` | +| 제거된 속성 | 대체 | +| -------- | ------------- | +| `format` | `time_format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [time] @@ -250,14 +250,14 @@ behind = "⇣${count}" ++ format = "at 🕙[$time]($style) " ``` -#### Custom Commands +#### 사용자 지정 명령 -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| 제거된 속성 | 대체 | +| -------- | -------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**기본 구성 변경 사항** ```diff [custom.example] diff --git a/docs/ko-KR/presets/README.md b/docs/ko-KR/presets/README.md index a162b0267..1c20df82f 100644 --- a/docs/ko-KR/presets/README.md +++ b/docs/ko-KR/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -이 프리셋은 [starship의 추후 배포](https://github.com/starship/starship/pull/3544)에서 기본 프리셋이 될 예정입니다. - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [클릭하여 No Nerd Font 프리셋 보기](./no-nerd-font) diff --git a/docs/ko-KR/presets/catppuccin-powerline.md b/docs/ko-KR/presets/catppuccin-powerline.md index 2d629c545..fffbd9101 100644 --- a/docs/ko-KR/presets/catppuccin-powerline.md +++ b/docs/ko-KR/presets/catppuccin-powerline.md @@ -1,14 +1,14 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[프리셋으로 돌아가기](./#catppuccin-powerline) -# Catppuccin Powerline Preset +# Catppuccin Powerline 프리셋 -This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette. +이 프리셋은 [Catppuccin](https://github.com/catppuccin/catppuccin) 테마 팔레트를 사용하여 [Gruvbox Rainbow](./gruvbox-rainbow.md)를 최소한으로 수정한 버전입니다. -![Screenshot of Catppuccin Powerline preset](/presets/img/catppuccin-powerline.png) +![Catppuccin Powerline 프리셋 스크린샷](/presets/img/catppuccin-powerline.png) ### 준비 사항 -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal +- 터미널에 [Nerd Font](https://www.nerdfonts.com/) 설치 및 활성화 ### 설정 @@ -16,13 +16,13 @@ This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainb starship preset catppuccin-powerline -o ~/.config/starship.toml ``` -By default this preset uses the Mocha flavour of Catppucin, but you can specify any of the flavours by modifying the value of `palette`: +기본적으로 이 프리셋은 Catppuccin의 Mocha 플레이버를 사용하지만, `palette` 값을 수정하여 다음 플레이버 중 하나를 지정할 수 있습니다. - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` -[Click to download TOML](/presets/toml/catppuccin-powerline.toml) +[클릭하여 TOML 다운로드](/presets/toml/catppuccin-powerline.toml) <<< @/public/presets/toml/catppuccin-powerline.toml diff --git a/docs/ko-KR/presets/pure-preset.md b/docs/ko-KR/presets/pure-preset.md index 123b67ce9..694a9ffc9 100644 --- a/docs/ko-KR/presets/pure-preset.md +++ b/docs/ko-KR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[프리셋으로 돌아가기](./#pure) +[프리셋으로 돌아가기](./#pure-prompt) # Pure 프리셋 diff --git a/docs/ko-KR/presets/tokyo-night.md b/docs/ko-KR/presets/tokyo-night.md index 963636ed0..426861c1a 100644 --- a/docs/ko-KR/presets/tokyo-night.md +++ b/docs/ko-KR/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[프리셋으로 돌아가기](./#pastel-powerline) +[프리셋으로 돌아가기](./#tokyo-night) # Tokyo Night 프리셋 diff --git a/docs/nl-NL/README.md b/docs/nl-NL/README.md index 8134a006a..b2e05a317 100644 --- a/docs/nl-NL/README.md +++ b/docs/nl-NL/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - Add the following to the end of `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/nl-NL/advanced-config/README.md b/docs/nl-NL/advanced-config/README.md index 4a1df3133..8fe921ebd 100644 --- a/docs/nl-NL/advanced-config/README.md +++ b/docs/nl-NL/advanced-config/README.md @@ -2,11 +2,7 @@ While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. -::: warning - -The configurations in this section are subject to change in future releases of Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index 9eb15a836..0c6abcb39 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -9,17 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml -# Get editor completions based on the config schema +# Krijg editoraanvullingen gebaseerd op het configuratieschema "$schema" = 'https://starship.rs/config-schema.json' -# Inserts a blank line between shell prompts +# Voegt een witregel toe tussen shell commando's 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' +# Vervang het '❯' symbool in de prompt met '➜' +[character] # De naam van de module die we aan het configureren zijn is 'character' +success_symbol = '[➜](bold green)' # Het 'success_symbol' segment wordt gezet naar '➜' met de kleur 'bold green' -# Disable the package module, hiding it from the prompt completely +# Zet de 'package' module uit. Dit verbergt het volledig van de prompt [package] disabled = true ``` @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Variable | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ De `cobol` module laat de huidige geïnstalleerde versie van COBOL zien. By defa 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 Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Example +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Example | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Example diff --git a/docs/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index e3258f1c5..565172d09 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/guide/README.md @@ -230,9 +230,10 @@ Als alternatief kan je Starship installeren met een van de volgende pakketbeheer | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Add the following to the end of `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ If you're looking to further customize Starship: ## 🤝 Contributing -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). +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"). 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/). diff --git a/docs/nl-NL/presets/README.md b/docs/nl-NL/presets/README.md index 1a6862a11..72def9078 100644 --- a/docs/nl-NL/presets/README.md +++ b/docs/nl-NL/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/nl-NL/presets/catppuccin-powerline.md b/docs/nl-NL/presets/catppuccin-powerline.md index 38cdea6a1..a0d8202f2 100644 --- a/docs/nl-NL/presets/catppuccin-powerline.md +++ b/docs/nl-NL/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/nl-NL/presets/pure-preset.md b/docs/nl-NL/presets/pure-preset.md index b27468de9..d4dc71508 100644 --- a/docs/nl-NL/presets/pure-preset.md +++ b/docs/nl-NL/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/nl-NL/presets/tokyo-night.md b/docs/nl-NL/presets/tokyo-night.md index db5cec786..b305f7011 100644 --- a/docs/nl-NL/presets/tokyo-night.md +++ b/docs/nl-NL/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/no-NO/README.md b/docs/no-NO/README.md index d2ac526d2..f0e13d3c7 100644 --- a/docs/no-NO/README.md +++ b/docs/no-NO/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvisk - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - Legg til følgende i slutten av `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/no-NO/advanced-config/README.md b/docs/no-NO/advanced-config/README.md index 678593e33..13e2c7d84 100644 --- a/docs/no-NO/advanced-config/README.md +++ b/docs/no-NO/advanced-config/README.md @@ -2,11 +2,7 @@ While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. -::: warning - -The configurations in this section are subject to change in future releases of Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/no-NO/config/README.md b/docs/no-NO/config/README.md index 08c43de73..6d6d05f20 100644 --- a/docs/no-NO/config/README.md +++ b/docs/no-NO/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Variable | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Example +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Example | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Example diff --git a/docs/no-NO/guide/README.md b/docs/no-NO/guide/README.md index 614a1a443..7b8a8d94a 100644 --- a/docs/no-NO/guide/README.md +++ b/docs/no-NO/guide/README.md @@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvisk -Legg til følgende i slutten av `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Merk: Bare Alvisk v0.18+ støttes +Merk: Bare Alvisk v0.18+ støttes. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ If you're looking to further customize Starship: ## 🤝 Contributing -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). +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"). 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/). diff --git a/docs/no-NO/presets/README.md b/docs/no-NO/presets/README.md index 1a6862a11..72def9078 100644 --- a/docs/no-NO/presets/README.md +++ b/docs/no-NO/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/no-NO/presets/catppuccin-powerline.md b/docs/no-NO/presets/catppuccin-powerline.md index f38e2ebfb..3ff25bb63 100644 --- a/docs/no-NO/presets/catppuccin-powerline.md +++ b/docs/no-NO/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/no-NO/presets/pure-preset.md b/docs/no-NO/presets/pure-preset.md index b27468de9..d4dc71508 100644 --- a/docs/no-NO/presets/pure-preset.md +++ b/docs/no-NO/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/no-NO/presets/tokyo-night.md b/docs/no-NO/presets/tokyo-night.md index e49a2168a..92090093a 100644 --- a/docs/no-NO/presets/tokyo-night.md +++ b/docs/no-NO/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/pl-PL/README.md b/docs/pl-PL/README.md index ad2ccd2f4..afe5e1f74 100644 --- a/docs/pl-PL/README.md +++ b/docs/pl-PL/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Działa tylko dla elvish v0.18 albo wyższej wersji. - - ::: - - Dodaj na koniec pliku `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - Ten sposób zmieni się w przyszłości. Działa tylko na Nushell v0.96+. - - ::: + > [!WARNING] This will change in the future. Działa tylko na Nushell v0.96+. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/pl-PL/advanced-config/README.md b/docs/pl-PL/advanced-config/README.md index 2b41ddfd0..fd90c2e13 100644 --- a/docs/pl-PL/advanced-config/README.md +++ b/docs/pl-PL/advanced-config/README.md @@ -2,11 +2,7 @@ Mimo że Starship jest wszechstronny, czasem nie wystarczy modyfikacja pliku `starship.toml` żeby osiągnąć zamierzony efekt. Na tej stronie opisano bardziej zaawansowane sposoby konfigurowania używane w Starship. -::: warning - -Konfiguracja opisana w tej sekcji może ulec zmianie w przyszłych wydaniach Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index 3f0a357ad..ea7a134d5 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: porada - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Zmienne | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: porada - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: porada +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: porada - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Zmienne | Example | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: porada - -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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Example +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Zmienne | Example | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: porada - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: porada - -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). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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. | -::: porada - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' 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. -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: porada - -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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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. -::: porada - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: porada - -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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Zmienne | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: porada +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: porada - -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. - -::: - -::: porada - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Example diff --git a/docs/pl-PL/guide/README.md b/docs/pl-PL/guide/README.md index 4e9ccc524..ca80dc13f 100644 --- a/docs/pl-PL/guide/README.md +++ b/docs/pl-PL/guide/README.md @@ -230,9 +230,10 @@ Alternatywnie, zainstaluj Starship używając dowolnego z następujących mened | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Dodaj na koniec pliku `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Uwaga: Obsługiwany jest tylko Elvish w wersji v0.18 wzwyż +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ Lecz jeśli chcesz nieco dostosować 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). +Zawsze szukamy pomocy od osób **na każdym poziomie zaawansowania**! 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 [Crowdin Starship](https://translate.starship.rs/). diff --git a/docs/pl-PL/presets/README.md b/docs/pl-PL/presets/README.md index 3ac6001a7..f00182c38 100644 --- a/docs/pl-PL/presets/README.md +++ b/docs/pl-PL/presets/README.md @@ -14,11 +14,7 @@ Ten zestaw ustawień zmienia symbole dla każdego modułu tak, by wykorzystywał To ustawienie zmienia symbole dla kilku modułów, tak aby żadne symbole Nerd Font nie były używane w wierszu poleceń. -::: porada - -To ustawienie stanie się domyślnym ustawieniem [w przyszłej wersji starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Kliknij, aby wyświetlić ustawienia No Nerd Font](./no-nerd-font) diff --git a/docs/pl-PL/presets/catppuccin-powerline.md b/docs/pl-PL/presets/catppuccin-powerline.md index 0d2e757e6..bebe6d1df 100644 --- a/docs/pl-PL/presets/catppuccin-powerline.md +++ b/docs/pl-PL/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/pl-PL/presets/pure-preset.md b/docs/pl-PL/presets/pure-preset.md index 81ba06425..157a699b5 100644 --- a/docs/pl-PL/presets/pure-preset.md +++ b/docs/pl-PL/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Powrót do ustawień predefiniowanych](./#pure) +[Powrót do ustawień predefiniowanych](./#pure-prompt) # Ustawienia Pure diff --git a/docs/pl-PL/presets/tokyo-night.md b/docs/pl-PL/presets/tokyo-night.md index 69b3d9410..1ec4c6a1b 100644 --- a/docs/pl-PL/presets/tokyo-night.md +++ b/docs/pl-PL/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Powrót do ustawień predefiniowanych](./#pastel-powerline) +[Powrót do ustawień predefiniowanych](./#tokyo-night) # Ustawienia Tokyo Night diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md index 296ce1f7d..2b6e7a025 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Apenas elvish v0.18 ou superior é suportado. - - ::: - - Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - Isto irá mudar no futuro. Somente Nushell v0.96+ é suportado. - - ::: + > [!WARNING] This will change in the future. Somente Nushell v0.96+ é suportado. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/pt-BR/advanced-config/README.md b/docs/pt-BR/advanced-config/README.md index 2a6f3af41..c16957211 100644 --- a/docs/pt-BR/advanced-config/README.md +++ b/docs/pt-BR/advanced-config/README.md @@ -2,11 +2,7 @@ Embora o Starship seja um shell versátil, às vezes é necessário fazer mais do que editar o `starship.toml` para que ele realize certas funções. Esta página detalha algumas das técnicas de configuração avançadas utilizadas no starship. -::: atenção - -As configurações nesta seção estão sujeitas a alterações em futuras versões do Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt no PowerShell diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index 3cc281ee3..51eb31ad4 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -208,11 +208,7 @@ Esta é a lista de opções de configuração em todo o prompt. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note que paletas de cores não podem referir-se a suas próprias definições de cores. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Exemplo @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' O módulo `azure` exibe a assinatura Azure atual. Isto é baseado na exibição do nome da assinatura padrão ou no nome do usuário, como definido no arquivo `~/.azure/azureProfile.json`. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Variável | Padrão | Descrição | @@ -658,15 +658,13 @@ O módulo `c` mostra algumas informações sobre o seu compilador de C. Por padr | symbol | | Espelha o valor da opção `symbol` | | style | | Espelha o valor da opção `style` | -Note que `version` não está no formato padrão. - ### Comandos A opção `commands` aceita uma lista de comandos para determinar a versão e o nome do compilador. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship tentará executar cada comando até que obtenha um resultado no STDOUT. -Se um compilador C não é suportado por este módulo, você pode solicitá-lo [criando uma issue no GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Exemplo @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Espelha o valor da opção `symbol` | | style | | Espelha o valor da opção `style` | -Note que `version` não está no formato padrão. - ### Comandos A opção `commands` aceita uma lista de comandos para determinar a versão e o nome do compilador. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship tentará executar cada comando até que obtenha um resultado no STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Exemplo @@ -735,11 +733,7 @@ O caractere vai te dizer se o ultimo comando foi bem sucedido ou não. Você pod 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Opções @@ -855,13 +849,11 @@ O módulo `cobol` exibe a versão instalada atual do COBOL. Por padrão, o módu O módulo `cmd_duration` exibi o tempo que o ultimo comando levou para executar. O módulo vai exibir somente se o comando levar mais de dois segundos, ou o valor de configuração `min_time` existir. -::: warning Não utilize o DEBUG-trap no Bash +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -Se você esta rodando o Starship no `bash`, você não deve ativar a armadilha `DEBUG` após rodar `eval $(starship init $0)`, ou este módulo **vai** quebrar. - -::: - -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). Simplesmente defina os arrays `preexec_functions` e `precmd_functions` antes de rodar `eval $(starship init $0)`, e depois pode proceder normalmente. ### Opções @@ -897,13 +889,9 @@ 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`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Opções @@ -970,7 +958,7 @@ 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/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `shard.yml` - O diretório atual contem um arquivo `.cr` @@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) ' ## Dart -O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem algum arquivo com extensão `.dart` - O diretório atual contem um diretório `.dart_tool` @@ -1087,7 +1075,7 @@ 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/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### 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` | `'🐳 '` | 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` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Quais arquivos devem acionar este módulo (precisa que `only_with_files` seja true). | +| `detect_folders` | `[]` | Quais pastas devem acionar este módulo (precisa que `only_with_files` seja true). | +| `style` | `'blue bold'` | O estilo do módulo. | +| `disabled` | `false` | Desabilita o módulo `docker_context`. | ### Variáveis @@ -1426,26 +1416,17 @@ O módulo `env_var` exibe o valor atual de uma variável de ambiente selecionada - A opção de configuração da `variable` corresponde a uma variável existente - A configuração `variable` não está definida, mas a `default` está -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Múltiplas variáveis de ambiente podem ser exibidas usando um `.`. (Veja o exemplo) se a configuração `variable` não é definida, o módulo irá exibir o valor da variável após o caractere `.`. - -Exemplo: a configuração a seguir irá mostrar o valor da variável de ambiente USER - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!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. +> +> Exemplo: a configuração a seguir irá mostrar o valor da variável de ambiente USER +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Opções @@ -1596,10 +1577,49 @@ Produz um prompt parecido com: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Opções + +| Opções | Padrão | Descrição | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `symbol` | `' '` | O simbolo usado antes de exibir a versão do COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | O estilo do módulo. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['fpm.toml']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | Como detectar qual é o compilador | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| --------- | -------- | ----------------------------------- | +| name | gfortran | O nome do compilador | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +A opção `commands` aceita uma lista de comandos para determinar a versão e o nome do compilador. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship tentará executar cada comando até que obtenha um resultado no STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -1759,6 +1781,7 @@ O módulo `git_branch` exibe o branch ativo do repositório no diretório atual. | `truncation_symbol` | `'…'` | O simbolo usado para indicar que o nome braço foi truncado. You can use `''` for no symbol. | | `only_attached` | `false` | Apenas exibe o nome do braço quando o estado não for detached `HEAD`. | | `ignore_branches` | `[]` | Uma lista de nomes para evitar a exibição. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Desabilita o módulo `git_branch`. | ### Variáveis @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' O módulo `git_metrics` vai exibir o número de adições e exclusões de linhas no repositório git atual. -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ### Opções @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' O módulo `git_status` exibe o simbolo que representa o estado do repositório no diretório atual. -::: tip - -O módulo Git Status é muito lento nos diretórios do Windows (por exemplo, em `/mnt/c/`) quando em um ambiente WSL. Você pode desabilitar o módulo ou usar a opção `windows_starship` para usar um executável Starship nativo do Windows para calcular o `git_status` para esses caminhos. - -::: +> [!TIP] The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. Você pode desabilitar o módulo ou usar a opção `windows_starship` para usar um executável Starship nativo do Windows para calcular o `git_status` para esses caminhos. ### Opções @@ -1925,7 +1940,7 @@ O módulo Git Status é muito lento nos diretórios do Windows (por exemplo, em | `diverged` | `'⇕'` | O formato do `diverged` | | `up_to_date` | `''` | O formato do `up_to_date` | | `untracked` | `'?'` | O formato do `untracked` | -| `stashed` | `'$'` | O formato do `stashed` | +| `stashed` | `'\$'` | O formato do `stashed` | | `modified` | `'!'` | O formato do `modified` | | `staged` | `'+'` | O formato do `staged` | | `renamed` | `'»'` | O formato do `renamed` | @@ -2392,17 +2407,9 @@ A funcionalidade padrão é: - 1 job -> `symbol` é exibido. - 2 jobs or more -> `symbol` + `number` é exibido. -::: atenção +> [!WARNING] This module is not supported on tcsh. -Este módulo não é suportado em tcsh e nu. - -::: - -::: atenção - -A opção `threshold` está obsoleta, mas se você quiser usa-la, o módulo vai exibir o numero de jobs rodando se for maior que 1 ou maior que o valor configurado na `threshold`, se ele existir. Se o valor `threshold` for definido como 0, então o módulo vai exibir quando tiver 0 jobs rodando. - -::: +> [!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. ### Opções @@ -2428,7 +2435,7 @@ A opção `threshold` está obsoleta, mas se você quiser usa-la, o módulo vai *: Esta variável só pode ser usada como parte de uma string de estilo -### Exemplo +### Exemplos ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia O módulo `julia` exibe a versão atual instalada do [Julia](https://julialang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: @@ -2530,21 +2545,13 @@ kotlin_binary = 'kotlinc' Exibe o nome atual do [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) e, se definido, o namespace, usuário e cluster do arquivo kubeconfig. O namespace precisa ser definido no arquivo kubeconfig, isso pode ser feito via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Se a env var `$KUBECONFIG` estiver definida o módulo vai usa-la ao invés de usar o `~/.kube/config`. -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Opções -::: atenção - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Opções | Padrão | Descrição | | ------------------- | ---------------------------------------------------- | ------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true O módulo `localip` mostra o endereço IPv4 da interface primária de rede. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -2742,11 +2751,7 @@ O módulo `memory_usage` mostra a memória atual do sistema e o uso de troca. Por padrão o uso do swap é exibido se o total de swap do sistema é diferente de zero. -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ### Opções @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + +### Opções + +| Opções | Padrão | Descrição | +| ------------ | --------------------------- | ----------------------------------------------------------------- | +| `merge` | `'MERGING'` | O formato de string exibida quando um `merge` esta em progresso. | +| `rebase` | `'REBASING'` | O formato de string exibida quando um `rebase` esta em progresso. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | O formato de string exibida quando um `bisect` esta em progresso. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | O estilo do módulo. | +| `format` | `'\([$state]($style)\) '` | O formato do módulo. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| ---------------- | ---------- | -------------------------------------- | +| state | `REBASING` | O estado atual do repo | +| progress_current | `1` | O progresso da operação atual | +| progress_total | `2` | O total do progresso da operação atual | +| style\* | | Espelha o valor da opção `style` | + +*: Esta variável só pode ser usada como parte de uma string de estilo + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | O símbolo usado antes de exibir a versão do Zig. | -| `style` | `'bold bright-blue'` | O estilo do módulo. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | 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. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | 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 @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: atenção +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ### Opções @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Versionamento de Pacotes -O módulo `package` é mostrado quando o diretório atual é o repositório de um pacote e mostra sua versão atual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +O módulo `package` é mostrado quando o diretório atual é o repositório de um pacote e mostra sua versão atual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – O versionamento de pacotes `npm` é extraído do `package.json` presente no diretório atual - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ O módulo `package` é mostrado quando o diretório atual é o repositório de u - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - O versionamento de pacotes `sbt` pé extraído do arquivo `build.sbt` presente no diretório atual - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Opções @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | O simbolo usado antes do nome do environment. | -| `style` | `'yellow bold' | O estilo do módulo. | +| `style` | `'yellow bold'` | O estilo do módulo. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_files` | `['pixi.toml']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `['.pixi']` | Quais pastas devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `disabled` | `false` | Disables the `pixi` module. | ### Variáveis @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' O módulo `pulumi` mostra o nome de usuário atual, a [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/) selcionada e a versão. -::: tip - -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). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). Se você ainda deseja ativa-la, [siga o exemplo abaixo](#with-pulumi-version). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: @@ -3712,13 +3742,9 @@ Por padrão, o módulo será exibido se qualquer das seguintes condições for a | `detect_folders` | `[]` | Quais pastas devem ativar este módulo | | `disabled` | `false` | Desabilita o módulo `python`. | -::: 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. - -O valor padrão e a ordem para o `python_binary` foram escolhidos para identificar primeiro uma versão do Python em um ambiente virtualenv/conda (que atualmente adiciona um `python`, não importa se ele aponta pro `python3` ou `python2`). Este tem efeito de lado, se você tenha um sistema com Python 2 instalado, pode ser usado antes de qualquer Python 3 (pelo menos nas Distros Linux que sempre fazem um symlink `/usr/bin/python` para Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!TIP] The `python_binary` variable accepts either a string or a list of strings. O Starship vai tentar executar cada binário até obter um resultado. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. +> +> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. ### Variáveis @@ -4036,11 +4062,7 @@ symbol = '🌟 ' O módulo de `shell` exibe um indicador para o shell que esta sendo usado. -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ### Opções @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. + ### Opções | Opções | Padrão | Descrição | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' O módulo `status` exibe o código de saída do comando anterior. Se o $success_symbol estiver vazio (padrão), o módulo será exibido apenas se o código de saída não for `0.`. O código de status será convertido em um inteiro de 32 bits signed. -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ### Opções @@ -4305,11 +4325,7 @@ disabled = false O módulo `sudo` é exibido se uma credencial sudo estiver em cache. O módulo vai ser exibido somente se as credenciais estiverem em cache. -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ### Opções @@ -4391,13 +4407,9 @@ 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. +O módulo `terraform` exibe o [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) selecionado e sua versão. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. Se você deseja habilitar,, [Siga o exemplo abaixo](#with-terraform-version). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: @@ -4406,16 +4418,17 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | A string de formato do módulo. | -| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | Uma string que é exibida antes do workspace terraform. | -| `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`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | A string de formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | Uma string que é exibida antes do workspace terraform. | +| `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`. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variáveis @@ -4436,7 +4449,7 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Sem a versão do Terraform @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$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. -::: tip - -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. - -::: +> [!TIP] This module is disabled by default. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ### Opções @@ -4537,11 +4546,7 @@ O módulo `username` mostra o nome de usuário do usuário ativo. O módulo ser - A variável `show_always` esta definida como true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Opções @@ -4684,6 +4689,35 @@ O módulo `vcsh` exibe o repositório [VCSH](https://github.com/RichiH/vcsh) atu format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). Por padrão o módulo será ativo se qualquer das condições a seguir for atendida: + +- O diretório atual conter um arquivo `xmake.lua` + +### Opções + +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | O simbolo usado antes da versão do cmake. | +| `detect_extensions` | `[]` | Quais extensões devem acionar este módulo | +| `detect_files` | `['xmake.lua']` | [] | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo | +| `style` | `'bold green'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default 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: @@ -4734,31 +4768,17 @@ Esses módulos serão mostrados se alguma das seguintes condições for atendida - O comando `when` retorna 0 - The current Operating System (std::env::consts::OS) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Vários módulos personalizados podem ser definidos usando um `.`. +> [!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 `${...}`). Por padrão, o módulo `custom` mostrará todos os módulos personalizados na ordem em que eles foram definidos. -::: +> [!TIP] [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. Se você tem um exemplo interessante que não esta coberto lá, sinta-se livre para compartilha-lo! -::: tip - -A ordem na qual os módulos personalizados são mostrados pode ser definida individualmente incluindo `${custom.foo}` no `format` de nível superior (como inclui um ponto, você precisa usar `${...}`). Por padrão, o módulo `custom` mostrará todos os módulos personalizados na ordem em que eles foram definidos. - -::: - -::: 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! - -::: - -::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 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. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 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. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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 @@ -4808,17 +4828,15 @@ Se o `shell` não for dado ou apenas conter um elemento e o Starship detectar Po shell = ['pwsh', '-Command', '-'] ``` -::: warning Tenha certeza que tenha uma configuração de shell - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Exemplo diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 0074f68c7..5207e190c 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -230,9 +230,10 @@ Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Nota: Somente Elvish v0.18+ é suportado +Nota: Somente Elvish v0.18+ é suportado. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ 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). +Nós estamos sempre procurando contribuidores de **todos os níveis de conhecimento**! 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/). @@ -436,7 +437,7 @@ Code Signing Roles: - Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts) - Approvers and Authors: [Mission Control](https://github.com/orgs/starship/teams/mission-control) -This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it. +Este programa nāo transferirá qualquer informação para outros sistemas em rede, a menos que seja especificamente solicitado pelo usuário ou a pessoa que o esteja instalando ou operando.


diff --git a/docs/pt-BR/presets/README.md b/docs/pt-BR/presets/README.md index c4ac66228..80b4c0abf 100644 --- a/docs/pt-BR/presets/README.md +++ b/docs/pt-BR/presets/README.md @@ -14,11 +14,7 @@ Essa predefinição altera os símbolos para cada módulo usar símbolos com Ner Essa predefinição altera os símbolos para vários módulos para que nenhum utilize símbolos das Nerd Fonts em nenhum lugar no prompt. -::: tip - -Esta predefinição se tornará padrão em [uma futura release do starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Clique para visualizar a predefinição de sem Nerd Font](./no-nerd-font) @@ -74,7 +70,7 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts. -[![Screenshot of Jetpack preset](/presets/img/jetpack.png "Click to view Jetpack preset")](./jetpack) +[![Captura de tela do Jetpack preset](/presets/img/jetpack.png "Click to view Jetpack preset")](./jetpack) ## [Catppuccin Powerline](./catppuccin-powerline.md) diff --git a/docs/pt-BR/presets/catppuccin-powerline.md b/docs/pt-BR/presets/catppuccin-powerline.md index 0ae03f99d..ef4ead70d 100644 --- a/docs/pt-BR/presets/catppuccin-powerline.md +++ b/docs/pt-BR/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/pt-BR/presets/jetpack.md b/docs/pt-BR/presets/jetpack.md index 884be3537..11f91c4db 100644 --- a/docs/pt-BR/presets/jetpack.md +++ b/docs/pt-BR/presets/jetpack.md @@ -6,7 +6,7 @@ This is a pseudo minimalist preset inspired by the [geometry](https://github.com > Jetpack uses the terminal's color theme. -![Screenshot of Jetpack preset](/presets/img/jetpack.png) +![Captura de tela do Jetpack preset](/presets/img/jetpack.png) ### Prerequisite diff --git a/docs/pt-BR/presets/pure-preset.md b/docs/pt-BR/presets/pure-preset.md index 1293d811f..9837e9b22 100644 --- a/docs/pt-BR/presets/pure-preset.md +++ b/docs/pt-BR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Retornar para Personalizações](./#pure) +[Retornar para Personalizações](./#pure-prompt) # Personalização do prompt do terminal com Pure diff --git a/docs/pt-BR/presets/tokyo-night.md b/docs/pt-BR/presets/tokyo-night.md index 94ffd2dfd..9b615b5f6 100644 --- a/docs/pt-BR/presets/tokyo-night.md +++ b/docs/pt-BR/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Retornar para Personalizações](./#pastel-powerline) +[Retornar para Personalizações](./#tokyo-night) # Predifinição Tokyo Night diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md index 52f44555f..50742ea4e 100644 --- a/docs/pt-PT/README.md +++ b/docs/pt-PT/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - Add the following to the end of `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/pt-PT/advanced-config/README.md b/docs/pt-PT/advanced-config/README.md index 678593e33..13e2c7d84 100644 --- a/docs/pt-PT/advanced-config/README.md +++ b/docs/pt-PT/advanced-config/README.md @@ -2,11 +2,7 @@ While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. -::: warning - -The configurations in this section are subject to change in future releases of Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index 08c43de73..6d6d05f20 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Variable | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | style | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Example +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Example | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `style` | `'yellow bold' | The style for the module. | +| `style` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Example diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index 5d8c5fb49..2064fd5f2 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/guide/README.md @@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()

Elvish -Add the following to the end of `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ If you're looking to further customize Starship: ## 🤝 Contributing -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). +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"). 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/). diff --git a/docs/pt-PT/presets/README.md b/docs/pt-PT/presets/README.md index 1a6862a11..72def9078 100644 --- a/docs/pt-PT/presets/README.md +++ b/docs/pt-PT/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/pt-PT/presets/catppuccin-powerline.md b/docs/pt-PT/presets/catppuccin-powerline.md index e738fe694..e46cff7a4 100644 --- a/docs/pt-PT/presets/catppuccin-powerline.md +++ b/docs/pt-PT/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/pt-PT/presets/pure-preset.md b/docs/pt-PT/presets/pure-preset.md index b27468de9..d4dc71508 100644 --- a/docs/pt-PT/presets/pure-preset.md +++ b/docs/pt-PT/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/pt-PT/presets/tokyo-night.md b/docs/pt-PT/presets/tokyo-night.md index fbb8020fc..1aba4dd21 100644 --- a/docs/pt-PT/presets/tokyo-night.md +++ b/docs/pt-PT/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md index fca5b342b..18cf0f9fd 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Только elvish v0.18 или выше поддерживается. - - ::: - - Добавьте следующую строку в конец `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - Это изменится в будущем. Поддерживается только Nushell v0.96+. - - ::: + > [!WARNING] This will change in the future. Поддерживается только Nushell v0.96+. Добавьте следующее в конец вашей конфигурации Nushell (найдите это, запустив `$nu.config-path` в Nushell): diff --git a/docs/ru-RU/advanced-config/README.md b/docs/ru-RU/advanced-config/README.md index 3434b98dd..3e8e08820 100644 --- a/docs/ru-RU/advanced-config/README.md +++ b/docs/ru-RU/advanced-config/README.md @@ -2,11 +2,7 @@ Хотя Starship - это универсальная оболочка, иногда вам нужно сделать больше, чем просто редактировать `starship.toml`, для того чтобы сделать определенные вещи. Эта страница описывает некоторые из дополнительных техник конфигурации, используемых в Starship. -::: warning - -Конфигурации в этом разделе могут быть изменены в будущих выпусках Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt для PowerShell diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index 750b64bfc..a1c45fa61 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -208,11 +208,7 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts'] | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Пример @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Переменная | По умолчанию | Описание | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Отражает значение параметра `symbol` | | style | | Отражает значение параметра `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Пример @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Отражает значение параметра `symbol` | | style | | Отражает значение параметра `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Пример @@ -735,11 +733,7 @@ format = 'via [$name $version]($style)' 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Опции @@ -855,13 +849,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t Модуль `cmd_duration` показывает время исполнения последней команды. Модуль будет показан только, если команда заняла более двух секунд, или если задан параметр `min_time`. -::: warning Не подключайте ловушку DEBUG к Bash +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -Если вы испоьзуете Starship в `bash`, не подключайте ловушку `DEBUG` после запуска `eval $(starship init $0)`, иначе этот модуль сломается. - -::: - -Пользователи Bash, которым нужна функциональность, подобная 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). Просто определите массивы `preexec_functions` и `precmd_functions` перед запуском `eval $(starship init $0)`, а затем продолжайте нормально. ### Опции @@ -899,11 +891,7 @@ 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. -::: tip - -Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Опции @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | Формат модуля. | -| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `'blue bold'` | Стиль модуля. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | Формат модуля. | +| `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` | `['compose.yml', 'compose.yaml', '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. | ### Переменные @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - Опция `variable` соответствует существующей переменной среды - Опция `variable` не определена, но определена опция `default` -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Опции @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | Стиль модуля. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | + +*: Эта переменная может использоваться только в качестве части строки style + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -1759,6 +1781,7 @@ very-long-project-name = 'vlpn' | `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Отключает модуль `git_branch`. | ### Переменные @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ### Опции @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' Модуль `git_status` отображает символы, представляющие состояние репозитория в вашей текущей директории. -::: 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. - -::: +> [!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. ### Опции @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Опции @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: Эта переменная может использоваться только в качестве части строки style -### Пример +### Примеры ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Опции -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Параметр | По умолчанию | Описание | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -2742,11 +2751,7 @@ format = 'via [🌕 $version](bold blue) ' По умолчанию использование подкачки отображается, если общая сумма подкачки системы не равна нулю. -::: tip - -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ### Опции @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | Стиль модуля. | +| `format` | `'\([$state]($style)\) '` | Формат модуля. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Отражает значение параметра `style` | + +*: Эта переменная может использоваться только в качестве части строки style + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | Стиль модуля. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | Стиль модуля. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Переменные @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ### Опции @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Версия пакета -Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ Arch = "Arch is the best! " - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Опции @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | Формат модуля. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | Символ перед названием окружения. | -| `style` | `'yellow bold' | Стиль модуля. | +| `style` | `'yellow bold'` | Стиль модуля. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Переменные @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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. ### Переменные @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ### Опции @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. + ### Опции | Параметр | По умолчанию | Описание | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' 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` в файле конфигурации. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ### Опции @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ### Опции @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `terraform`. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `style` | `'bold 105'` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `terraform`. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Переменные @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Время Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры. -::: tip - -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. - -::: +> [!TIP] This module is disabled by default. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ### Опции @@ -4537,11 +4546,7 @@ By default, the module will be shown if any of the following conditions are met: - Переменная `show_always` равна true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Опции @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- Текущий каталог содержит файл `xmake.lua` + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | Стиль модуля. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | + +*: Эта переменная может использоваться только в качестве части строки style + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Модуль будет показан, если любое из следующих условий соблюдено: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Опции @@ -4808,17 +4828,15 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt shell = ['pwsh', '-Command', '-'] ``` -::: предупреждение Убедитесь, что ваша пользовательская конфигурация оболочки завершается корректно - -Если вы задаете собственную команду, убедитесь, что оболочка по умолчанию, используемая starship, правильно выполняет команду с плавным выходом (через опцию `shell`). - -Например, PowerShell требует параметра `-Command` для выполнения одного лайнера. Пропуск этого параметра может привести к тому, что starship попадет в рекурсивный цикл, в котором оболочка может попытаться снова загрузить среду с полным профилем с помощью starship и, следовательно, повторно выполнить пользовательскую команду, попадая в бесконечный цикл. - -Параметры, аналогичные `-NoProfile` в PowerShell, рекомендуются для других оболочек, a также, чтобы избежать дополнительного времени загрузки пользовательского профиля на каждом starship вызове. - -Автоматическое определение оболочек и добавление соответствующих параметров в настоящее время реализованы, но возможно, что не все оболочки покрыты. [Пожалуйста, откройте проблему](https://github.com/starship/starship/issues/new/choose) с подробной информацией о shell и конфигурации starship, если вы столкнетесь с таким сценарием. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index e3bde205e..1124abd84 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Добавьте следующую строку в конец `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Примечание: поддерживается только Elvish v0.18+ +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ eval "$(starship init zsh)" ## 🤝 Помощь -Мы всегда ищем помощь людей **всех уровней навыков**! Если вы хотите облегчить свой путь к проекту, посмотрите хорошие первые ошибки ([first good issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)). +Мы всегда ищем помощь людей **всех уровней навыков**! 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/). diff --git a/docs/ru-RU/presets/README.md b/docs/ru-RU/presets/README.md index 3bbecfc84..40cbc1d61 100644 --- a/docs/ru-RU/presets/README.md +++ b/docs/ru-RU/presets/README.md @@ -14,11 +14,7 @@ Этот пресет изменяет символы для нескольких модулей таким образом, чтобы в приглашении командной строки нигде не использовались символы Nerd Font. -::: tip - -Этот пресет станет пресетом по умолчанию [в будущем релизе starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Нажмите, чтобы просмотреть пресет No Nerd Font](./no-nerd-font) diff --git a/docs/ru-RU/presets/catppuccin-powerline.md b/docs/ru-RU/presets/catppuccin-powerline.md index 438afead0..aa63b5d54 100644 --- a/docs/ru-RU/presets/catppuccin-powerline.md +++ b/docs/ru-RU/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/ru-RU/presets/pure-preset.md b/docs/ru-RU/presets/pure-preset.md index 9d66b7219..d99c08eb6 100644 --- a/docs/ru-RU/presets/pure-preset.md +++ b/docs/ru-RU/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Вернуться к пресетам](./#pure) +[Вернуться к пресетам](./#pure-prompt) # Пресет Pure diff --git a/docs/ru-RU/presets/tokyo-night.md b/docs/ru-RU/presets/tokyo-night.md index 3ad87ef76..f093e5201 100644 --- a/docs/ru-RU/presets/tokyo-night.md +++ b/docs/ru-RU/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Вернуться к пресетам](./#pastel-powerline) +[Вернуться к пресетам](./#tokyo-night) # Пресет Tokyo Night diff --git a/docs/tr-TR/README.md b/docs/tr-TR/README.md index 902cd3451..b05b94792 100644 --- a/docs/tr-TR/README.md +++ b/docs/tr-TR/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Only elvish v0.18 or higher is supported. - - ::: - - `~/.elvish/rc.elv` dosyasının sonuna ekleyin: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - This will change in the future. Only Nushell v0.96+ is supported. - - ::: + > [!WARNING] This will change in the future. Only Nushell v0.96+ is supported. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/tr-TR/advanced-config/README.md b/docs/tr-TR/advanced-config/README.md index c39aed35a..1172f399b 100644 --- a/docs/tr-TR/advanced-config/README.md +++ b/docs/tr-TR/advanced-config/README.md @@ -2,11 +2,7 @@ Starship çok yönlü bir kabuk olsa da, yine de belirli şeyleri yapması için `starship.toml`'u düzenlemek gerekebilir. Bu sayfa, Starship'i daha fazla yapılandırma tekniklerini anlatır. -::: uyarı - -Bu bölümdeki yapılandırmalar, Starship'in gelecekteki sürümlerinde değişiklik gösterebilir. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## PowerShell'de TransientPrompt diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md index b135c5fd1..b0e8aa084 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/config/README.md @@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Variable | Default | Description | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Mirrors the value of option `symbol` | | stil | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Mirrors the value of option `symbol` | | stil | | Mirrors the value of option `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example @@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). -::: uyarı - -`vimcmd_symbol` yalnızca cmd, fish ve zsh'de desteklenir. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash - -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. - -::: +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. 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. @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the 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). | -| `stil` | `'blue bold'` | The style for the module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | The format for the 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` | `['compose.yml', 'compose.yaml', '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). | +| `stil` | `'blue bold'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `stil` | `'bold purple'` | The style for the module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: 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. - -::: +> [!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. ### Options @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: uyarı +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: uyarı - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Options @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: This variable can only be used as a part of a style string -### Example +### Examples ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2530,21 +2545,13 @@ 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`. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options -::: uyarı - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Option | Default | Description | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2742,11 +2751,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. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +### Options + +| Option | Default | Description | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `stil` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state]($style)\) '` | The format for the module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Variables + +| Variable | Example | Description | +| ---------------- | ---------- | ----------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `stil` | `'bold bright-blue'` | The style for the module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `stil` | `'bold bright-blue'` | The style for the module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: uyarı +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 the environment name. | -| `stil` | `'yellow bold' | The style for the module. | +| `stil` | `'yellow bold'` | The style for the module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | | `disabled` | `false` | Disables the `pixi` module. | ### Variables @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3712,13 +3742,9 @@ 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 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. - -::: +> [!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. +> +> 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 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + ### Options | Option | Default | Description | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `stil` | `'bold 105'` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | +| `stil` | `'bold 105'` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Variables @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Time 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 - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: +> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Options @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- The current directory contains a `xmake.lua` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `stil` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Options @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Example diff --git a/docs/tr-TR/faq/README.md b/docs/tr-TR/faq/README.md index c9975ce61..b85fa9ec5 100644 --- a/docs/tr-TR/faq/README.md +++ b/docs/tr-TR/faq/README.md @@ -1,18 +1,18 @@ -# Frequently Asked Questions +# Sıkça Sorulan Sorular -## What is the configuration used in the demo GIF? +## Demo görselinde kullanılan konfigürasyon nedir? -- **Terminal Emulator**: [iTerm2](https://iterm2.com/) - - **Theme**: Minimal - - **Color Scheme**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy) - - **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) +- **Terminal Emülatorü**: [iTerm2](https://iterm2.com/) + - **Tema**: Minimal + - **Renk Şeması**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy) + - **Yazı Tipi**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) - **Shell**: [Fish Shell](https://fishshell.com/) - - **Configuration**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) + - **Konfigürasyon**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **Prompt**: [Starship](https://starship.rs/) -## How do I get command completion as shown in the demo GIF? +## Demo görselinde gösterilen kod tamamlamasını nasıl elde ederim? -Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). +Tamamlama desteği ya da otomatik tamamlama seçtiğiniz shell tarafından sağlanır. Demo, [Fish Shell](https://fishshell.com/) ile gerçekleştirildiğinden otomatik tamamlama bu shell tarafından varsayılan olarak sağlanmaktadır. Eğer Z Shell (zsh) kullanılıyorsa, [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) adresine bakabilirsiniz. ## Do top level `format` and `.disabled` do the same thing? diff --git a/docs/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index 9a405b464..746198de0 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/guide/README.md @@ -230,9 +230,10 @@ Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebil | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Paketleri](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Paketleri](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -`~/.elvish/rc.elv` dosyasının sonuna ekleyin: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Not: Elvish v0.18'den sonraki sürümler desteklenmektedir +Not: Elvish v0.18'den sonraki sürümler desteklenmektedir. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ Daha fazla özelleştirme seçeneği için: ## 🤝 Katkıda Bulunmak -Katılımcılara **yetenek düzeyleri fark etmeksizin**, her zaman açığız! Eğer katkıda bulunmaya kolay bir şekilde başlamak istiyorsanız [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)'lardan bir tanesini deneyin. +Katılımcılara **yetenek düzeyleri fark etmeksizin**, her zaman açığız! 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"). Eğer ingilizce harici bir dili akıcı seviyede kullanabiliyorsanız, dosyaların diğer diller ile güncel bir şekilde çevirilebilmesi için yardımlarınızı bekliyoruz. Çeviriye [Starship Crowdin](https://translate.starship.rs/)'den destekte bulunabilirsiniz. diff --git a/docs/tr-TR/presets/README.md b/docs/tr-TR/presets/README.md index ee6415f4d..876fef8e8 100644 --- a/docs/tr-TR/presets/README.md +++ b/docs/tr-TR/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/tr-TR/presets/catppuccin-powerline.md b/docs/tr-TR/presets/catppuccin-powerline.md index 88c605d9f..3bb3815e9 100644 --- a/docs/tr-TR/presets/catppuccin-powerline.md +++ b/docs/tr-TR/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/tr-TR/presets/pure-preset.md b/docs/tr-TR/presets/pure-preset.md index 299cc23ba..13b6b9265 100644 --- a/docs/tr-TR/presets/pure-preset.md +++ b/docs/tr-TR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/tr-TR/presets/tokyo-night.md b/docs/tr-TR/presets/tokyo-night.md index 7d0359dbc..903ac8b03 100644 --- a/docs/tr-TR/presets/tokyo-night.md +++ b/docs/tr-TR/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/uk-UA/README.md b/docs/uk-UA/README.md index 4363081ab..f55f77051 100644 --- a/docs/uk-UA/README.md +++ b/docs/uk-UA/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Підтримується лише elvish v0.18 або новішої версії. - Підтримуються лише elv0.18 або вище. - - ::: - - Додайте наступний рядок наприкінці `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - Це зміниться в майбутньому. Підтримується лише Nushell v0.96+. - - ::: + > [!WARNING] У майбутньому це може змінитись. Підтримується лише Nushell v0.96+. Додайте наступний рядок наприкінці налаштувань Nushell (знайдіть її за допомоги `$nu.config-path` в Nushell): diff --git a/docs/uk-UA/advanced-config/README.md b/docs/uk-UA/advanced-config/README.md index a9bb1337d..06244bab2 100644 --- a/docs/uk-UA/advanced-config/README.md +++ b/docs/uk-UA/advanced-config/README.md @@ -2,11 +2,7 @@ Хоча Starship і універсальна оболонка, іноді необхідно зробити більше ніж просто змінити `star.toml`, щоб можна було робити певні речі. Ця сторінка містить деякі з найбільш докладних методів налаштувань, які використовуються у starship. -::: warning - -Налаштування у цьому розділі можуть змінюватись у майбутніх релізах Starship. - -::: +> [!WARNING] Конфігурації в цьому розділі можуть бути змінені в майбутніх випусках Starship. ## TransientPrompt у PowerShell diff --git a/docs/uk-UA/config/README.md b/docs/uk-UA/config/README.md index eef983b11..8a866bb2b 100644 --- a/docs/uk-UA/config/README.md +++ b/docs/uk-UA/config/README.md @@ -208,11 +208,7 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts'] | `palettes` | `{}` | Колекція колірних палітр, для призначення [кольорів](../advanced-config/#style-strings) до назв визначених користувачем. Зверніть увагу, що кольорові палітри не можуть посилатися на їх власні визначення кольору. | | `follow_symlinks` | `true` | Перевіряти символічні посилання чи вони посилаються на теки; використовується в таких модулях як git. | -::: tip - -Якщо у вас є символічні посилання не мережеві файлові системи, зважте на встановлення `follow_symlink` у `false`. - -::: +> [!TIP] Якщо у вас є символічні посилання до мережевих файлових систем, встановіть `follow_symlinks` у `false`. ### Приклад @@ -249,7 +245,7 @@ mustard = '#af8700' ```toml format = '$all' -# Which is equivalent to +# Є еквівалентом до format = """ $username\ $hostname\ @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' Модуль `azure` показує поточну підписку Azure. Інформація заснована на назві стандартної підписки або імені користувача, як визначено у файлі `~/.azure/azureProfile.json`. +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Змінна | Стандартно | Опис | @@ -658,15 +658,13 @@ format = 'via [🍔 $version](bold green) ' | symbol | | Віддзеркалює значення параметра `symbol` | | style | | Віддзеркалює значення параметра `style` | -NB `версія` не має стандартного формату. - ### Команди Параметр `commands` отримує список команд для визначення версії та назви компілятора. Кожна команда представлена списком з назви виконавчого файлу та аргументів, зазвичай `['myc', '--version']`. Starship спробує виконати кожну команду, поки не отримає результат в STDOUT. -Якщо C-компілятор не підтримується цим модулем, ви можете зробити [запит на GitHub](https://github.com/starship/starship/). +Якщо C-компілятор не підтримується цим модулем, ви можете зробити [запит на GitHub](https://github.com/starship/starship/issues/new/choose). ### Приклад @@ -679,7 +677,9 @@ format = 'via [$name $version]($style)' ## CPP -The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +Модуль `cpp` показує інформацію про ваш компілятор `C++`. Стандартно модуль буде показаний, якщо поточна тека містить файли `.cpp`, `.hpp`, або інші файли повїязані з `C++`. + +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -693,7 +693,7 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | `detect_folders` | `[]` | В яких теках цей модуль має запускатись. | | `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | Як виявити компілятор | | `style` | `'bold 149'` | Стиль модуля. | -| `disabled` | `true` | Disables the `cpp` module. | +| `disabled` | `true` | Вимикає модуль `cpp`. | ### Змінні @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Віддзеркалює значення параметра `symbol` | | style | | Віддзеркалює значення параметра `style` | -NB `версія` не має стандартного формату. - ### Команди Параметр `commands` отримує список команд для визначення версії та назви компілятора. -Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship спробує виконати кожну команду, поки не отримає результат в STDOUT. +Кожна команда представлена списком з назви виконавчого файлу та аргументів, зазвичай `['mycpp', '--version']`. Starship спробує виконати кожну команду, поки не отримає результат в STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +Якщо компілятор C++ компілятор не підтримується цим модулем, ви можете зробити [запит на GitHub](https://github.com/starship/starship/issues/new/choose). ### Приклад @@ -735,11 +733,7 @@ format = 'via [$name $version]($style)' Стандартно відбувається зміна кольору. Якщо ви також хочете змінювати й символ, подивитися на [цей приклад](#with-custom-error-shape). -::: warning - -`vimcmd_symbol` працює лише з cmd, fish та zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` працює лише з fish через [проблему визначення режиму роботи в zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` підтримується лише у cmd, fish та zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol` та `vimcmd_visual_symbol` підтримуються лише у fish через [проблеми з визначенням режиму у zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Параметри @@ -855,11 +849,9 @@ vimcmd_symbol = '[V](bold green) ' Модуль `cmd_duration` показує, скільки часу виконувалась остання команда. Модуль буде показаний лише в тому випадку, якщо на виконання команди пішло понад дві секунди або більше, ніж значення змінної `min_time`, якщо воно задане. -::: warning Не вмикайте DEBUG trap в Bash - -Якщо ви запускаєте Starship у `bash`, не вмикайте `DEBUG trap` після запуску `eval $(starship init $0)`, бо цей модуль **не працюватиме**. - -::: +> [!WARNING] Не перехоплюйте trap DEBUG у Bash +> +> Якщо ви запускаєте Starship у `bash`, не вмикайте `DEBUG trap` після запуску `eval $(starship init $0)`, бо цей модуль **не працюватиме**. Користувачі Bash, яким потрібна функція preexec, можуть використовувати [фреймворк bash_preexec від rcaloras](https://github.com/rcaloras/bash-preexec). Просто визначте масиви `preexec_function` і `precmd_functions` перед запуском `eval $(starship init $0)`, а потім продовжуйте як зазвичай. @@ -899,11 +891,7 @@ format = 'underwent [$duration](bold yellow)' Модуль `conda` показує інформацію про поточне оточення [Conda](https://docs.conda.io/en/latest/), якщо змінна `$CONDA_DEFAULT_ENV` встановлена. -::: tip - -Це не призводить до вимикання власного модифікатора командного рядка в conda. Можливо, вам доведеться виконати `conda config --set changeps1 False`. Якщо ви використовуєте [pixi](https://pixi.sh), ви можете відключити модифікатор запиту pixi, запустивши `pixi config set change-ps1 false`. - -::: +> [!TIP] Це не пригнічує власний модифікатор підказки conda, ви можете виконати `conda config --set changeps1 False`. Якщо ви використовуєте [pixi](https://pixi.sh), ви можете відключити модифікатор запиту pixi, використовуючи `pixi config set shell.change-ps1 false`. ### Параметри @@ -914,7 +902,7 @@ format = 'underwent [$duration](bold yellow)' | `style` | `'bold green'` | Стиль модуля. | | `format` | `'via [$symbol$environment]($style) '` | Формат модуля. | | `ignore_base` | `true` | Ігнорувати середовище `base`. | -| `detect_env_vars` | `["!PIXI_ENVIRONMENT_NAME"]` | Які змінні середовища повинні запускати цей модуль. If it's a pixi environment, this module is not being triggered by default. | +| `detect_env_vars` | `["!PIXI_ENVIRONMENT_NAME"]` | Які змінні середовища повинні запускати цей модуль. Якщо це середовище pixi, цей модуль стандартно не запускається. | | `disabled` | `false` | Вимикає модуль `conda`. | ### Змінні @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' Модуль `direnv` показує статус rc-файла якщо він існує. Статус включає: шлях до файлу rc, чи він завантажений та, чи `direnv` дозволяє його використання. +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Параметр | Стандартно | Опис | @@ -1251,16 +1241,16 @@ disabled = false ### Параметри -| Параметр | Стандартно | Опис | -| ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | Формат модуля. | -| `symbol` | `'🐳 '` | Символ, який знаходиться перед Docker context. | -| `only_with_files` | `true` | Показувати, лише коли є збіг | -| `detect_extensions` | `[]` | Які розширення мають запускати цей модуль (потрібно щоб в `only_with_files` було true). | -| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Які імена файлів мають запускати цей модуль (потрібно щоб в `only_with_files` було true). | -| `detect_folders` | `[]` | Які теки мають запускати цей модуль (потрібно щоб в `only_with_files` було true). | -| `style` | `'blue bold'` | Стиль модуля. | -| `disabled` | `false` | Вимикає модуль `docker_context`. | +| Параметр | Стандартно | Опис | +| ------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | Формат модуля. | +| `symbol` | `'🐳 '` | Символ, який знаходиться перед Docker context. | +| `only_with_files` | `true` | Показувати, лише коли є збіг | +| `detect_extensions` | `[]` | Які розширення мають запускати цей модуль (потрібно щоб в `only_with_files` було true). | +| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Які імена файлів мають запускати цей модуль (потрібно щоб в `only_with_files` було true). | +| `detect_folders` | `[]` | Які теки мають запускати цей модуль (потрібно щоб в `only_with_files` було true). | +| `style` | `'blue bold'` | Стиль модуля. | +| `disabled` | `false` | Вимикає модуль `docker_context`. | ### Змінні @@ -1426,26 +1416,17 @@ format = 'via [ $version](cyan bold) ' - Параметр `variable` відповідає наявній змінній середовища - Параметр `variable` не визначено, але є параметр `default` -::: tip +> [!TIP] Порядок показу модулів env_var можна встановити індивідуально, включивши `${env_var.foo}` у формат верхнього рівня `format` (оскільки він містить крапку, потрібно використовувати `${...}`). Типово, модуль `env_var` покаже усі модулі env_var, в тому порядку, в якому вони були визначені. -Порядок в якому модуль env_var показується може встановлюватись індивідуально додаванням `${env_var.foo}` в `format` верхнього рівня (через те, що використовуються крапки, потрібно використовувати `${...}`). Типово, модуль `env_var` покаже усі модулі env_var, в тому порядку, в якому вони були визначені. - -::: - -::: tip - -Кілька змінних оточення можуть бути показані за допомоги `.`. (див. приклад) Якщо параметр конфігурації `variable` не встановлено, модуль показуватиме значення змінної під назвою тексту після символу `.`. - -Приклад: наступна конфігурація показуватиме значення змінної середовища USER - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Кілька змінних середовища можна відобразити за допомогою `.`. (див. приклад) Якщо параметр конфігурації `variable` не задано, модуль виводитиме значення змінної під назвою тексту після символу `.`. +> +> Приклад: наступна конфігурація показуватиме значення змінної середовища USER +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Параметри @@ -1596,10 +1577,49 @@ style = 'bold green' AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +Модуль `fortran` показує поточну встановлену версію Fortran. + +### Параметри + +| Параметр | Стандартно | Опис | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| `symbol` | `' '` | Символ, який знаходиться перед версією COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | +| `version_format` | `'${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` | +| `style` | `'bold purple'` | Стиль модуля. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. | +| `detect_files` | `['fpm.toml']` | Які імена файлів мають запускати цей модуль. | +| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | Як виявити компілятор | +| `disabled` | `false` | Вимикає модуль `fortran`. | + +### Змінні + +| Змінна | Приклад | Опис | +| --------- | -------- | ---------------------------------------- | +| name | gfortran | Назва компілятора | +| version | `14.2.0` | Версія компілятора Fortran | +| symbol | | Віддзеркалює значення параметра `symbol` | +| style\* | | Віддзеркалює значення параметра `style` | + +*: Ця змінна може бути використана лише як частина стилю рядка + +### Команди + +Параметр `commands` отримує список команд для визначення версії та назви компілятора. + +Кожна команда представлена списком з назви виконавчого файлу та аргументів, зазвичай `['myfortran', '--version']`. Starship спробує виконати кожну команду, поки не отримає результат в STDOUT. + +Якщо компілятор Fortran не підтримується цим модулем, ви можете зробити [запит на GitHub](https://github.com/starship/starship/). + ## Fossil Branch Модуль `fossil_branch` показує назву активної гілки у вашій поточній теці. +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Параметр | Стандартно | Опис | @@ -1636,6 +1656,8 @@ truncation_symbol = '' Модуль `fossil_metrics` покаже кількість доданих та видалених рядків у поточній теці. Потрібна версія Fossil не нижче v2.14 (2021-01-20). +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Параметр | Стандартно | Опис | @@ -1759,6 +1781,7 @@ very-long-project-name = 'vlpn' | `truncation_symbol` | `'…'` | Символ, що використовується для позначення назви гілки, яка була скорочена. Ви можете використовувати `''`, щоб нічого не показувати. | | `only_attached` | `false` | Показувати назву гілки тільки коли вона не у відʼєднаному від `HEAD` стані. | | `ignore_branches` | `[]` | Перелік назв, які не треба показувати. Корисно для 'master' або 'main'. | +| `ignore_bare_repo` | `false` | Не показувати, коли в голих репозиторіях. | | `disabled` | `false` | Вимикає модуль `git_branch`. | ### Змінні @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' Модуль `git_metrics` покаже кількість доданих та видалених рядків у поточному репозиторії git. -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' Модуль `git_status` показує символ, що описує стан репозиторію в поточній теці. -::: tip - -Модуль Git Status дуже повільно працює в теках Windows у середовищі WSL (наприклад, під `/mnt/c/`). Ви можете вимкнути модуль або використати `windows_starship` для використання Windows-версії Starship для тримання `git_status` для цих шляхів. - -::: +> [!TIP] Модуль Git Status працює дуже повільно у теках Windows (наприклад, у теках `/mnt/c/`) у середовищі WSL. Ви можете вимкнути модуль або використати `windows_starship` для використання Windows-версії Starship для тримання `git_status` для цих шляхів. ### Параметри @@ -1925,7 +1940,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' | `diverged` | `'⇕'` | Формат `diverged` | | `up_to_date` | `''` | Формат `up_to_date` | | `untracked` | `'?'` | Формат `untracked` | -| `stashed` | `'$'` | Формат `stashed` | +| `stashed` | `'\$'` | Формат `stashed` | | `modified` | `'!'` | Формат `modified` | | `staged` | `'+'` | Формат `staged` | | `renamed` | `'»'` | Формат `renamed` | @@ -1935,7 +1950,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' | `ignore_submodules` | `false` | Ігнорувати зміни в субмодулях. | | `disabled` | `false` | Вимикає модуль `git_status`. | | `windows_starship` | | Використовуйте цей (Linux) шлях до виконуваного файлу у Windows для показу `git_status` у випадку шляхів Windows у WSL. | -| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. | +| `use_git_executable` | `false` | Не використовуйте `gitoxide` для обчислення статусу, натомість використовуйте виконуваний файл `git`. | ### Змінні @@ -2392,17 +2407,9 @@ symbol = '🌟 ' - 1 завдання -> показується `symbol`. - 2 чи більше завдань -> показується `symbol` + `число`. -::: warning +> [!WARNING] Цей модуль не підтримується на tcsh. -Модуль не підтримується в tcsh та nu. - -::: - -::: warning - -Параметр `threshold` є застарілим, але якщо ви бажаєте його використовувати, модуль буде показувати кількість запущених завдань, якщо у вас більше одного фонового завдання, або завдань більше за `threshold`. Якщо `threshold` встановлено у 0, то модуль також показуватиметься, коли немає запущених завдань. - -::: +> [!WARNING] Параметр `threshold` є застарілим, але якщо ви хочете використовувати його, модуль покаже кількість запущених завдань, якщо їх більш ніж 1, або більше значення конфігурації `threshold`, якщо воно існує. Якщо `threshold` встановлено у 0, то модуль також показуватиметься, коли немає запущених завдань. ### Параметри @@ -2428,7 +2435,7 @@ symbol = '🌟 ' *: Ця змінна може бути використана лише як частина стилю рядка -### Приклад +### Приклади ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Зміна процесу групування поведінки у fish + +При використанні оболонки Fish, Starship стандартно підраховує **групи завдань** замість окремих ідентифікаторів процесів. Це запобігає надмірному підрахунку, коли конвеєр має кілька процесів, але тільки одну призупинену групу. Щоб повернутися до старого підрахунку на основі PID, додайте наступне до конфігурації оболонки: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia Модуль `julia` показує поточну встановлену версію [Julia](https://julialang.org/). Типово, модуль показується, якщо виконується будь-яка з наступних умов: @@ -2530,21 +2545,13 @@ kotlin_binary = 'kotlinc' Показує поточну назву [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) та, якщо встановлено, простір імен, користувача та кластер з файлу kubeconfig. Простір імен повинен бути встановлений у файлі kubeconfig файл, це можна зробити через `kubectl config set-context starship-context --namespace astronaut`. Так само можна встановити користувача та кластер за допомогою `kubectl config set-context starship-context --user starship-user` та `kubectl config set-context context context context --cluster starship-cluster`, відповідно. Якщо параметр `$KUBECONFIG` встановлено, то модуль буде використовувати його, якщо ні — `~/.kube/config`. -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -Коли модуль увімкнено, він завжди буде активним, якщо будь-який з параметрів `detect_env_vars`, `detect_extensions`, `detect_files` або `detect_folders` встановлені, модуль буде активним тільки в теках, що відповідають умовам. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. +> +> Коли модуль увімкнено, він завжди буде активним, якщо будь-який з параметрів `detect_env_vars`, `detect_extensions`, `detect_files` або `detect_folders` встановлені, модуль буде активним тільки в теках, що відповідають умовам або якщо одна зі змінних середовища була встановлена. ### Параметри -::: warning - -Параметри `context_aliases` та `user_aliases` є застарілими. Використовуйте `contexts` та, відповідно, `context_alias` та `user_alias`, натомість. - -::: +> [!WARNING] Параметри `context_aliases` та `user_aliases` є застарілими. Використовуйте `contexts` та, відповідно, `context_alias` та `user_alias`, натомість. | Параметр | Стандартно | Опис | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true Модуль `localip` показує IPv4 адресу основного мережевого інтерфейсу. +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Параметр | Стандартно | Опис | @@ -2742,11 +2751,7 @@ format = 'via [🌕 $version](bold blue) ' Стандартно використання файлу підкачки показується якщо його розмір не є нульовим. -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' Модуль `hg_branch` показує активну гілку та вершину репозиторію у вашій поточній теці. +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Параметр | Стандартно | Опис | @@ -2859,26 +2866,61 @@ truncation_length = 4 truncation_symbol = '' ``` -## Mise +## Стан Mercurial -The `mise` module shows the current mise health as reported by running `mise doctor`. +Модуль `hg_state` показуватиметься в теках, які є частиною сховища mercurial, і в яких виконується операція, наприклад: _REBASING_, _BISECTING_ тощо. + +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри -| Параметр | Стандартно | Опис | -| ------------------ | -------------------------------- | ------------------------------------------------ | -| `symbol` | `'mise '` | The symbol used before displaying _mise_ health. | -| `style` | `'bold purple'` | Стиль модуля. | -| `format` | `'on [$symbol$health]($style) '` | Формат модуля. | -| `healthy_symbol` | `healthy` | The message displayed when _mise_ is healthy. | -| `unhealthy_symbol` | `unhealthy` | The message displayed when _mise_ is unhealthy. | -| `disabled` | `true` | Disables the `mise` module. | +| Параметр | Стандартно | Опис | +| ------------ | --------------------------- | ------------------------------------------ | +| `merge` | `'MERGING'` | Формат рядка під час процесу `merge`. | +| `rebase` | `'REBASING'` | Формат рядка під час процесу `rebase`. | +| `update` | `'UPDATING'` | Формат рядка під час процесу `update`. | +| `bisect` | `'BISECTING'` | Формат рядка під час процесу `bisect`. | +| `shelve` | `'SHELVING'` | Формат рядка під час процесу `shelve`. | +| `graft` | `'GRAFTING'` | Формат рядка під час процесу `graft`. | +| `transplant` | `'TRANSPLANTING'` | Формат рядка під час процесу `transplant`. | +| `histedit` | `'HISTEDITING'` | Формат рядка під час процесу `histedit`. | +| `style` | `'bold yellow'` | Стиль модуля. | +| `format` | `'\([$state]($style)\) '` | Формат модуля. | +| `disabled` | `true` | Вимикає модуль `hg_state`. | + +### Змінні + +| Змінна | Приклад | Опис | +| ---------------- | ---------- | --------------------------------------- | +| state | `REBASING` | Поточний стан репозиторію | +| progress_current | `1` | Прогрес поточної операції | +| progress_total | `2` | Загальний прогрес операції | +| style\* | | Віддзеркалює значення параметра `style` | + +*: Ця змінна може бути використана лише як частина стилю рядка + +## Mise + +Модуль `mise` показує поточний стан mise, про який повідомляє запуск `mise doctor`. + +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + +### Параметри + +| Параметр | Стандартно | Опис | +| ------------------ | -------------------------------- | --------------------------------------------------------- | +| `symbol` | `'mise '` | Символ, який використовується перед показом стану _mise_. | +| `style` | `'bold purple'` | Стиль модуля. | +| `format` | `'on [$symbol$health]($style) '` | Формат модуля. | +| `healthy_symbol` | `healthy` | Повідомлення, яке показується, коли _mise_ справний. | +| `unhealthy_symbol` | `unhealthy` | Повідомлення, яке показується, коли _mise_ несправний. | +| `disabled` | `true` | Вимикає модуль `mise`. | ### Змінні | Змінна | Приклад | Опис | | --------- | --------- | ---------------------------------------- | -| health | `healthy` | The health of _mise_ | +| health | `healthy` | Стан справності _mise_ | | symbol | | Віддзеркалює значення параметра `symbol` | | style\* | | Віддзеркалює значення параметра `style` | @@ -3175,7 +3217,7 @@ format = 'via [🐪 $version]($style) ' | ------------------- | ------------------------------------ | -------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | | `show_commit` | `false` | Показує коміт як частину версії. | -| `symbol` | `'Ø '` | Символ, який знаходиться перед версією Zig. | +| `symbol` | `'Ø '` | Символ, який знаходиться перед версією Odin. | | `style` | `'bold bright-blue'` | Стиль модуля. | | `disabled` | `false` | Вимикає модуль `odin`. | | `detect_extensions` | `['odin']` | Які розширення повинні запускати цей модуль. | @@ -3277,17 +3319,9 @@ symbol = '☁️ ' Модуль `os` показує поточну операційну систему. Інформація про ОС отримується через [os_info](https://lib.rs/crates/os_info). -::: warning +> [!WARNING] Crate [os_info](https://lib.rs/crates/os_info), що використовується цим модулем, може бути не точним в деяких системах. -[os_info](https://lib.rs/crates/os_info), що використовується в цьому модулі, може бути неточним для деяких систем. - -::: - -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -Модуль `package` показується, коли поточна тека є сховищем для пакунка, і показує його поточну версію. Наразі модуль підтримує такі пакунки: `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` та `dart`. +Модуль `package` показується, коли поточна тека є сховищем для пакунка, і показує його поточну версію. Наразі модуль підтримує такі пакунки: `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` та `dart`. - [**npm**](https://docs.npmjs.com/cli/commands/npm) — версія пакунка `npm` отримується з `package.json` з поточної теки - [**JSR**](https://jsr.io/) — версія пакунка `jsr` отримана з файлів `jsr.json`/`jsr.jsonc` чи `deno.json`/`deno.jsonc` у поточній теці @@ -3403,6 +3438,7 @@ Arch = "Arch is the best! " - [**Maven**](https://maven.apache.org/) — версія пакунка `maven` отримується з `pom.xml` з поточної теки - [**Meson**](https://mesonbuild.com/) — версія пакунка `meson` отримується з `meson.build` з поточної теки - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) — версія пакунка `shards` отримується з `shard.yml` з поточної теки +- [**Galaxy**](https://galaxy.ansible.com/) — версія пакунка `galaxy` отримується з `galaxy.yml` з поточної теки - [**V**](https://vlang.io) — версія пакунка `vlang` отримується з `v.mod` з поточної теки - [**SBT**](https://scala-sbt.org) — версія пакунка `sbt` отримується з `build.sbt` з поточної теки - [**Daml**](https://www.digitalasset.com/developers) — версія пакунка `daml` отримується з `daml.yaml` з поточної теки @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' Модуль `pijul_channel` показує активний канал репозиторію у вашій поточній теці. +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Параметр | Стандартно | Опис | @@ -3537,35 +3575,31 @@ format = 'via [🔹 $version](147 bold) ' ## Pixi -The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. +Модуль `pixi` показує встановлену версію [pixi](https://pixi.sh), а також активоване середовище, якщо `$PIXI_ENVIRONMENT_NAME` встановлено. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] Це не пригнічує власний модифікатор підказки pixi, ви можете виконати `pixi config set shell.change-ps1 false`. ### Параметри -| Параметр | Стандартно | Опис | -| -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | Формат модуля. | -| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch`. | -| `symbol` | `'🧚 '` | Символ що передує назві оточення. | -| `style` | `'yellow bold' | Стиль модуля. | -| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | -| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | -| `detect_extensions` | `[]` | Які розширення повинні запускати цей модуль. | -| `detect_files` | `['pixi.toml']` | Які імена файлів мають запускати цей модуль. | -| `detect_folders` | `['.pixi']` | В яких теках цей модуль має запускатись. | -| `disabled` | `false` | Disables the `pixi` module. | +| Параметр | Стандартно | Опис | +| -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | Формат модуля. | +| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch`. | +| `symbol` | `'🧚 '` | Символ що передує назві оточення. | +| `style` | `'yellow bold'` | Стиль модуля. | +| `show_default_environment` | `true` | Чи вказувати, що у вашому проєкті активовано середовище `default`. | +| `pixi_binary` | `['pixi']` | Налаштовує бінарний файл pixi, який Starship буде використовувати для отримання версії. | +| `detect_extensions` | `[]` | Які розширення повинні запускати цей модуль. | +| `detect_files` | `['pixi.toml']` | Які імена файлів мають запускати цей модуль. | +| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. | +| `disabled` | `false` | Вимикає модуль `pixi`. | ### Змінні | Змінна | Приклад | Опис | | ----------- | --------- | ---------------------------------------- | -| version | `v0.33.0` | The version of `pixi` | -| environment | `py311` | The current pixi environment | +| version | `v0.33.0` | Версія `pixi` | +| environment | `py311` | Поточне середовище pixi | | symbol | | Віддзеркалює значення параметра `symbol` | | style | | Віддзеркалює значення параметра `style` | @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' Модуль `pulumi` показує імʼя поточного користувача та версію обраного [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/). -::: tip - -Стандартно версія Pulumi не показується, через те що для цього потрібно набагато більше часу ніж на завантаження більшості втулків (~70ms). Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче](#with-pulumi-version). - -::: +> [!TIP] Типово версія Pulumi не показується, оскільки вона завантажується на порядок довше, ніж більшість втулків (~70 мс). Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче](#with-pulumi-version). Типово, модуль показується, якщо виконується будь-яка з наступних умов: @@ -3698,27 +3728,23 @@ format = 'via [$symbol$version](bold white)' ### Параметри -| Параметр | Стандартно | Опис | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Формат модуля. | -| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` | -| `symbol` | `'🐍 '` | Формат рядка, що представляє символ Python | -| `style` | `'yellow bold'` | Стиль модуля. | -| `pyenv_version_name` | `false` | Використовувати pyenv для отримання версії Python | -| `pyenv_prefix` | `'pyenv'` | Префікс перед версією pyenv, показується якщо pyenv використовується | -| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should execute when getting the version. | -| `detect_extensions` | `['py', 'ipynb']` | Які розширення повинні запускати цей модуль | -| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Назви файлів, які активують модуль | -| `detect_folders` | `[]` | Назви тек, що активують модуль | -| `disabled` | `false` | Вимикає модуль `python`. | +| Параметр | Стандартно | Опис | +| -------------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Формат модуля. | +| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` | +| `symbol` | `'🐍 '` | Формат рядка, що представляє символ Python | +| `style` | `'yellow bold'` | Стиль модуля. | +| `pyenv_version_name` | `false` | Використовувати pyenv для отримання версії Python | +| `pyenv_prefix` | `'pyenv'` | Префікс перед версією pyenv, показується якщо pyenv використовується | +| `python_binary` | `['python', 'python3', 'python2']` | Налаштовує бінарні файли python, які Starship буде використовувати для отримання версії. | +| `detect_extensions` | `['py', 'ipynb']` | Які розширення повинні запускати цей модуль | +| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Назви файлів, які активують модуль | +| `detect_folders` | `[]` | Назви тек, що активують модуль | +| `disabled` | `false` | Вимикає модуль `python`. | -::: tip - -Змінна `python_binary` приймає як рядок, так і список рядків. Starship спробує запустити кожен бінарний файл, поки це не дасть результат. Зауважте, що можна змінити двійковий файл, який використовується Starship, щоб отримати версію Python, а не параметрів, які використовуються. - -Стандартні значення та порядок для `python_binary` було вибрано так, щоб спочатку ідентифікувати версію Python у середовищах virtualenv/conda (які наразі все ще додають `python`, незалежно від того, чи вказує він на `python3` чи на `python2`). Це може мати побічний ефект: якщо у вас все ще встановлено системний Python 2, він може бути обраний перед будь-яким Python 3 (принаймні в дистрибутивах Linux, які завжди містять символічне посилання `/usr/bin/python` на Python 2). Якщо ви більше не працюєте з Python 2, але не можете видалити системний Python 2, змінивши його на `'python3'`, ви приховаєте будь-яку версію Python 2, див. приклад нижче. - -::: +> [!TIP] Змінна `python_binary` приймає або рядок, або список рядків. Starship спробує запустити кожен бінарний файл, поки це не дасть результат. Зауважте, що можна змінити двійковий файл, який використовується Starship, щоб отримати версію Python, а не параметрів, які використовуються. +> +> Стандартні значення та порядок для `python_binary` було вибрано так, щоб спочатку ідентифікувати версію Python у середовищах virtualenv/conda (які наразі все ще додають `python`, незалежно від того, чи вказує він на `python3` чи на `python2`). Це може мати побічний ефект: якщо у вас все ще встановлено системний Python 2, він може бути обраний перед будь-яким Python 3 (принаймні в дистрибутивах Linux, які завжди містять символічне посилання `/usr/bin/python` на Python 2). Якщо ви більше не працюєте з Python 2, але не можете видалити системний Python 2, змінивши його на `'python3'`, ви приховаєте будь-яку версію Python 2, див. приклад нижче. ### Змінні @@ -4036,11 +4062,7 @@ symbol = '🌟 ' Модуль `shell` показує індикатор поточної оболонки. -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -4088,6 +4110,8 @@ disabled = false Модуль `shlvl` показує поточний [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') змінну оточення, якщо він встановлений на число і збігається або перевищує вказаний поріг. +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. + ### Параметри | Параметр | Стандартно | Опис | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' Модуль `status` показує код завершення роботи попередньої команди. Якщо $success_symbol пустий (типово), модуль буде показаний тільки якщо код виходу не `0`. Код status буде перетворений у 32-бітне ціле число. -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -4305,11 +4325,7 @@ disabled = false Модуль `sudo` показує, чи облікові дані sudo зараз є в кеші. Модуль показується лише за наявності даних в кеші. -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -Модуль `terraform` показує поточну вибрану [робочу область Terraform](https://www.terraform.io/docs/language/state/workspaces.html) і версію. +Модуль `terraform` показує поточну вибрану [робочу область Terraform](https://www.terraform.io/docs/language/state/workspaces.html) і версію. Він підтримує як Hashicorp Terraform, так і OpenTofu для виявлення версій. -::: tip - -Стандартно версія Terraform не показується, оскільки це повільно для поточних версій Terraform, особливо коли використовується багато втулків. Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче](#with-terraform-version). - -::: +> [!TIP] Типово версія Terraform/OpenTofu не показується, оскільки це повільно для поточних версій Terraform, коли використовується багато втулків. Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче](#with-terraform-version). Типово, модуль показується, якщо виконується будь-яка з наступних умов: @@ -4406,16 +4418,17 @@ format = 'via [🏎 $version](red bold)' ### Параметри -| Параметр | Стандартно | Опис | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | Формат рядка модуля. | -| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` | -| `symbol` | `'💠'` | Формат рядка, що відображається перед робочою областю terraform. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Які розширення повинні запускати цей модуль. | -| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. | -| `detect_folders` | `['.terraform']` | В яких теках цей модуль має запускатись. | -| `style` | `'bold 105'` | Стиль модуля. | -| `disabled` | `false` | Вимикає модуль `terraform`. | +| Параметр | Стандартно | Опис | +| ------------------- | ------------------------------------------------------- | ----------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | Формат рядка модуля. | +| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` | +| `symbol` | `'💠'` | Формат рядка, що відображається перед робочою областю terraform. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Які розширення повинні запускати цей модуль. | +| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. | +| `detect_folders` | `['.terraform']` | В яких теках цей модуль має запускатись. | +| `style` | `'bold 105'` | Стиль модуля. | +| `disabled` | `false` | Вимикає модуль `terraform`. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | Як визначити версію Terraform. | ### Змінні @@ -4436,7 +4449,7 @@ format = 'via [🏎 $version](red bold)' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Без версії Terraform @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$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), щоб побачити, які параметри доступні. -::: tip - -Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. - -::: +> [!TIP] Типово цей модуль вимкнено. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. ### Параметри @@ -4537,11 +4546,7 @@ time_range = '10:00:00-14:00:00' - Змінна `show_always` встановлена в true - Масив `detect_env_vars` містить принаймні одну змінну середовища, яку було встановлено -::: tip - -Модуль виявляє підключення SSH перевіряючи змінні середовища `SSH_CONNECTION`, `SSH_CLIENT` і `SSH_TTY`. Якщо ваш хост SSH не налаштував ці змінні, одним зі способів розвʼязання проблеми є встановлення для однієї з них фіктивного значення. - -::: +> [!TIP] SSH-зʼєднання виявляється шляхом перевірки змінних оточення `SSH_CONNECTION`, `SSH_CLIENT` та `SSH_TTY`. Якщо ваш хост SSH не налаштував ці змінні, одним зі способів розвʼязання проблеми є встановлення для однієї з них фіктивного значення. ### Параметри @@ -4684,6 +4689,35 @@ format = 'via [V $version](blue bold) ' format = '[🆅 $repo](bold blue) ' ``` +## XMake + +Модуль `xmake` показує поточну встановлену версію [XMake](https://xmake.io/). Типово, модуль показується, якщо виконується будь-яка з наступних умов: + +- Поточна тека містить файл `xmake.lua` + +### Параметри + +| Параметр | Стандартно | Опис | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | +| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` | +| `symbol` | `'△ '` | Символ, який йде перед версією cmak. | +| `detect_extensions` | `[]` | Які розширення повинні запускати цей модуль | +| `detect_files` | `['xmake.lua']` | Назви файлів, які активують модуль | +| `detect_folders` | `[]` | Назви тек, що активують модуль | +| `style` | `'bold green'` | Стиль модуля. | +| `disabled` | `false` | Вимикає модуль `xmake`. | + +### Змінні + +| Змінна | Приклад | Опис | +| --------- | -------- | ---------------------------------------- | +| version | `v2.9.5` | Версія xmake | +| symbol | | Віддзеркалює значення параметра `symbol` | +| style\* | | Віддзеркалює значення параметра `style` | + +*: Ця змінна може бути використана лише як частина стилю рядка + ## Zig Модуль `zig` показує поточну встановлену версію [Zig](https://ziglang.org/). Модуль показується, якщо виконується будь-яка з наступних умов: @@ -4734,31 +4768,17 @@ symbol = '⚡️ ' - Команда `when` повертає 0 - Поточна операційна система (std::env::consts::OS) збігається з полем `os`, якщо визначено. -::: tip +> [!TIP] Кілька власних модулів можна визначити за допомогою `.`. -Кілька власних модулів можна визначити за допомогою символу "`.`". +> [!TIP] Порядок показу власних модулів можна встановити індивідуально, включивши `${custom.foo}` у формат верхнього рівня `format` (оскільки він містить крапку, потрібно використовувати `${...}`). Типово, модуль `custom` покаже усі модулі custom, в тому порядку, в якому вони були визначені. -::: +> [!TIP] [Тікет #1252](https://github.com/starship/starship/discussions/1252) містить приклад власних модулів. Якщо у вас є цікавий приклад ще не розкритий там, не соромтеся, поділитися ним! -::: tip - -Порядок в якому власні модулі будуть показуватись може бути встановлений індивідуально додаванням `${custom.foo}` до змінної `format` верхнього рівня (через те, що назви містять точки вам треба використовувати`${...}`). Типово, модуль `custom` покаже усі модулі custom, в тому порядку, в якому вони були визначені. - -::: - -::: tip - -[Квиток #1252](https://github.com/starship/starship/discussions/1252) містить приклади власних модулів. Якщо у вас є цікавий приклад ще не розкритий там, не соромтеся, поділитися ним! - -::: - -::: warning Якщо увімкнено `unsafe_no_escape` або до версії starship v1.20 вивід команди буде виведено без екранування. - -Незалежно від результату, який генерує команда, він виводиться в командний рядок у незміненому вигляді. Це означає, що якщо вивід містить специфічні для оболонки інтерпретовані послідовності, вони можуть бути інтерпретовані безпосередньо під час виведення на екран. Залежно від оболонки, це може означати, що, наприклад, рядки, у зворотніх лапках, виконуються оболонкою. Такі послідовності зазвичай залежать від оболонки, наприклад, ви можете написати командний модуль, який пише послідовності для bash, наприклад, `\h`, але цей модуль не працюватиме в оболонці fish або zsh. - -Рядок формату також може містити специфічні послідовності командного рядка, наприклад [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). - -::: +> [!WARNING] Якщо увімкнено `unsafe_no_escape` або до версії starship v1.20 вивід команди буде показано без екранування. +> +> Незалежно від результату, який генерує команда, він виводиться в командний рядок у незміненому вигляді. Це означає, що якщо вивід містить специфічні для оболонки інтерпретовані послідовності, вони можуть бути інтерпретовані безпосередньо під час виведення на екран. Залежно від оболонки, це може означати, що, наприклад, рядки, у зворотніх лапках, виконуються оболонкою. Такі послідовності зазвичай залежать від оболонки, наприклад, ви можете написати командний модуль, який пише послідовності для bash, наприклад, `\h`, але цей модуль не працюватиме в оболонці fish або zsh. +> +> Рядки формату також можуть містити вказані послідовності запиту, наприклад [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ### Параметри @@ -4808,17 +4828,15 @@ symbol = '⚡️ ' shell = ['pwsh', '-Command', '-'] ``` -::: warning Переконайтеся, що ваша оболонка завершує процеси правильно - -Якщо ви вказуєте власну команду, переконайтеся, що стандартний Shell, який використовується starship, буде виконувати команди з чистим (graceful) завершенням, за допомогою параметра `shell`. - -Наприклад, PowerShell потребує параметр `-Command` для виконання однорядкової команди. Пропуск цього параметра може призвести до рекурсивного циклу starship, де оболонка може спробувати знову завантажити повний профіль середовища з самим starship і, отже, повторно виконати власну команду, потрапивши в нескінченний цикл. - -Параметри, подібні до `-NoProfile` у PowerShell, також рекомендовані для інших оболонок, щоб уникнути додаткового часу завантаження власного профілю під час кожного виклику Starship. - -Наразі реалізовано автоматичне виявлення оболонок і правильне додавання параметрів, але можливо, що охоплено не всі оболонки. [Будь ласка, сповістіть про проблему](https://github.com/starship/starship/issues/new/choose) з подробицями про термінал та конфігурацію автозапуску, якщо ви зіткнулись з таким сценарієм. - -::: +> [!WARNING] Переконайтеся, що ваша власна конфігурація оболонки відповідним чином завершує роботу +> +> Якщо ви вказуєте власну команду, переконайтеся, що стандартний Shell, який використовується starship, буде виконувати команди з чистим (graceful) завершенням, за допомогою параметра `shell`. +> +> Наприклад, PowerShell потребує параметр `-Command` для виконання однорядкової команди. Пропуск цього параметра може призвести до рекурсивного циклу starship, де оболонка може спробувати знову завантажити повний профіль середовища з самим starship і, отже, повторно виконати власну команду, потрапивши в нескінченний цикл. +> +> Параметри, подібні до `-NoProfile` у PowerShell, також рекомендовані для інших оболонок, щоб уникнути додаткового часу завантаження власного профілю під час кожного виклику Starship. +> +> Наразі реалізовано автоматичне виявлення оболонок і правильне додавання параметрів, але можливо, що охоплено не всі оболонки. [Будь ласка, сповістіть про проблему](https://github.com/starship/starship/issues/new/choose) з подробицями про термінал та конфігурацію автозапуску, якщо ви зіткнулись з таким сценарієм. ### Приклад diff --git a/docs/uk-UA/guide/README.md b/docs/uk-UA/guide/README.md index 25121477d..2cf573fa4 100644 --- a/docs/uk-UA/guide/README.md +++ b/docs/uk-UA/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Додайте наступний рядок наприкінці `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Примітка: Підтримується лише Elvish v0.18+ +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ eval "$(starship init zsh)" ## 🤝 Участь -Ми завжди раді вашому внеску, незалежно від рівня **вашого досвіду**! Якщо ви шукаєте спосіб допомоги проєкту, але ще не визначились, що можна зробити, спробуйте [завдання для початківців](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +Ми завжди раді вашому внеску, незалежно від рівня **вашого досвіду**! Якщо ви збираєтеся торувати свій шлях в проєкті, спробуйте розвʼязати [першу слушну проблему](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue"). Якщо ви вільно володієте мовою відмінною від англійської, ми будемо дуже вдячні, якщо ви допоможете в перекладі документації та її підтримці в актуальному стані. Якщо у вас є бажання, переклади можна робити за допомогою [Starship Crowdin](https://translate.starship.rs/). diff --git a/docs/uk-UA/presets/README.md b/docs/uk-UA/presets/README.md index a60cc6192..a31eb6c97 100644 --- a/docs/uk-UA/presets/README.md +++ b/docs/uk-UA/presets/README.md @@ -14,11 +14,7 @@ Цей стиль змінює символи для кількох модулів, щоб жодні символи Nerd Font не використовувалися в командному рядку. -::: tip - -Цей шаблон стане стандартним в [майбутньому випуску starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] Цей шаблон стане стандартним [у наступних випусках starship](https://github.com/starship/starship/pull/3544). [Натисніть для перегляду шаблона No Nerd Font](./no-nerd-font) diff --git a/docs/uk-UA/presets/catppuccin-powerline.md b/docs/uk-UA/presets/catppuccin-powerline.md index c2535a12b..3ea658c79 100644 --- a/docs/uk-UA/presets/catppuccin-powerline.md +++ b/docs/uk-UA/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Повернутися до Шаблонів](./README.md#catppuccin-powerline) +[Повернутися до Шаблонів](./#catppuccin-powerline) # Catppuccin Powerline @@ -21,7 +21,7 @@ starship preset catppuccin-powerline -o ~/.config/starship.toml - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Натисніть, щоб завантажити TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/uk-UA/presets/pure-preset.md b/docs/uk-UA/presets/pure-preset.md index 3b90840b6..4c62458fd 100644 --- a/docs/uk-UA/presets/pure-preset.md +++ b/docs/uk-UA/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Повернутися до Шаблонів](./#pure) +[Повернутися до Шаблонів](./#pure-prompt) # Pure Prompt diff --git a/docs/uk-UA/presets/tokyo-night.md b/docs/uk-UA/presets/tokyo-night.md index d0a1c0769..6763ce63e 100644 --- a/docs/uk-UA/presets/tokyo-night.md +++ b/docs/uk-UA/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Повернутися до Шаблонів](./#pastel-powerline) +[Повернутися до Шаблонів](./#tokyo-night) # Tokyo Night diff --git a/docs/vi-VN/README.md b/docs/vi-VN/README.md index 4de779b6a..305133003 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - Chỉ hỗ trợ elvish từ phiên bản 0.18 trở lên. - - ::: - - Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`: + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - Điều này có thể thay đổi trong tương lai. Chỉ hỗ trợ nushell từ phiên bản 0.96 trở lên. - - ::: + > [!WARNING] This will change in the future. Chỉ hỗ trợ nushell từ phiên bản 0.96 trở lên. Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/vi-VN/advanced-config/README.md b/docs/vi-VN/advanced-config/README.md index 40fd1cc7a..e825aa358 100644 --- a/docs/vi-VN/advanced-config/README.md +++ b/docs/vi-VN/advanced-config/README.md @@ -2,11 +2,7 @@ Trong khi Starship là một shell linh hoạt, đôi khi bạn vẫn cần làm nhiều hơn là chỉnh sửa `starship.toml` để có thể là được những việc nhất định. Tài liệu này sẽ mô tả chi tiết các tùy chỉnh nâng cao trong starship. -::: cảnh báo - -Các tùy chỉnh được mô tả trong phần này có thể sẽ thay đổi trong các phiên bản tương lai của Starship. - -::: +> [!WARNING] The configurations in this section are subject to change in future releases of Starship. ## TransientPrompt in PowerShell diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index a4f5c08f3..ecde9cba2 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -208,11 +208,7 @@ Cái này là danh sách các tuỳ chọn cho cấu hình prompt-wide. | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Ví dụ @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Các tuỳ chọn | Biến | Mặc định | Mô tả | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style | | Giá trị ghi đè của `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Ví dụ @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Options | Tuỳ chọn | Mặc định | Mô tả | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style | | Giá trị ghi đè của `style` | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Ví dụ @@ -735,11 +733,7 @@ Kí tự sẽ nói cho bạn câu lệnh cuối liệu thành công hay thất b 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options @@ -855,13 +849,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t Module `cmd_duration`. cho biết câu lệnh cuối cùng thực thi trong bao lâu. Module sẽ được hiện chỉ khi câu lệnh lấy nhiều hơn 2 giây, hoặc giá trị cấu hình `min_time`, nếu nó tồn tại. -::: warning Không thể hook DEBUG trap trong Bash +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -Nếu bạn đang chạy Starship trong `bash`, không thể hook `DEBUG` trap sau khi chạy `eval $(starship init $0)`, hoặc module này **sẽ** ngắt. - -::: - -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). Đơ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. ### Options @@ -899,11 +891,7 @@ 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. -::: 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`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Options | Tuỳ chọn | Mặc định | Mô tả | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| 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` | `'🐳 '` | 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` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Tên tệp tin nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `detect_folders` | `[]` | Thư mục nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `style` | `'blue bold'` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `docker_context`. | ### Các biến @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - Tùy chọn `variable` khớp với mootjj biến môi trường tồn tại - Tùy chọn `variable` không được định nghĩa, nhưng tùy chọn `default` là -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### Options @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### Options + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | Kiểu cho module. | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `['fpm.toml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| --------- | -------- | ----------------------------------- | +| name | gfortran | The name of the compiler | +| version | `14.2.0` | The version of the Fortran compiler | +| 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 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Options | Tuỳ chọn | Mặc định | Mô tả | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Options | Tuỳ chọn | Mặc định | Mô tả | @@ -1759,6 +1781,7 @@ Mô đun `git_branch` hiển thị nhánh hiệu lực của repo trong thư m | `truncation_symbol` | `'…'` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | Vô hiệu mô đun `git_branch`. | ### Các biến @@ -1826,7 +1849,7 @@ tag_symbol = '🔖 ' Mô đun `git_state` sẽ hiển hiển thị trong các thư mục là một phần của gt repository và những nơi tồn tại một hoạt động trong tiến trình như _REBASING_, _BISECTING_. Nếu có thông tin tiến trình (ví dụ, REBASING 3/10), thông tin đó cũng sẽ được hiển thị. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | -------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ### Các tuỳ chọn @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' Mô đun `git_status` hiển thị các biểu tượng đại diện cho trạng thái của repo trong thư mục hiện tại của bạn. -::: 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. - -::: +> [!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. ### Các tuỳ chọn @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | Định dạng của `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | Định dạng của `untracked` | -| `stashed` | `'$'` | Định dạng của `stashed` | +| `stashed` | `'\$'` | Định dạng của `stashed` | | `modified` | `'!'` | Định dạng của `modified` | | `staged` | `'+'` | Định dạng của `modified` | | `renamed` | `'»'` | Định dạng của `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: cảnh báo +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: cảnh báo - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### Các tuỳ chọn @@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will *: Biến này có thể chỉ được sử dụng như một phần của style string -### Ví dụ +### Các ví dụ ```toml # ~/.config/starship.toml @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.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: @@ -2530,21 +2545,13 @@ 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`. Nếu biến môi trường `$KUBECONFIG` được thiết lập, mô đun sẽ sử dụng cái đó nếu nó không sử dụng `~/.kube/config`. -::: tip - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Các tuỳ chọn -::: cảnh báo - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | @@ -2742,11 +2751,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. -::: tip - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ### Các tuỳ chọn @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + +### Các tuỳ chọn + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------ | --------------------------- | ---------------------------------------------------------------- | +| `merge` | `'MERGING'` | Một format sring hiển thị khi một `merge` đang trong quá trình. | +| `rebase` | `'REBASING'` | Một format sring hiển thị khi một `rebase` đang trong quá trình. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | Một format sring hiển thị khi một `bisect` đang trong quá trình. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | Kiểu cho module. | +| `format` | `'\([$state]($style)\) '` | Định dạng cho module. | +| `disabled` | `true` | Disables the `hg_state` module. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| ---------------- | ---------- | --------------------------------- | +| state | `REBASING` | Trạng thái của repo hiện tại | +| progress_current | `1` | Trạng thái của quá trình hiện tại | +| progress_total | `2` | Tổng số các quá trình | +| style\* | | Giá trị ghi đè của `style` | + +*: Biến này có thể chỉ được sử dụng như một phần của style string + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | Kiểu cho module. | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | Kiểu cho module. | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | ### Các biến @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: cảnh báo +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ### Các tuỳ chọn @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Các tuỳ chọn @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($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 tên biến môi trường. | -| `style` | `'yellow bold' | Kiểu cho module. | +| `style` | `'yellow bold'` | Kiểu cho module. | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `['pixi.toml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `['.pixi']` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | | `disabled` | `false` | Disables the `pixi` module. | ### Các biến @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!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). 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: @@ -3712,13 +3742,9 @@ By default, the module will be shown if any of the following conditions are met: | `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này | | `disabled` | `false` | Disables the `python` module. | -::: 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. - -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. - -::: +> [!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. +> +> 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. ### Các biến @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ### Các tuỳ chọn @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. + ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' 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 - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ### Các tuỳ chọn @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ### Các tuỳ chọn @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). 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: @@ -4406,16 +4418,17 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `['.terraform']` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `'bold 105'` | Kiểu cho module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `['.terraform']` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `'bold 105'` | Kiểu cho module. | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### Các biến @@ -4436,7 +4449,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## Thời gian 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 - -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. - -::: +> [!TIP] This module is disabled by default. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ### Các tuỳ chọn @@ -4537,11 +4546,7 @@ The `username` module shows active user's username. Module cho sẽ được hi - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### Các tuỳ chọn @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). 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: + +- Thư mục hiện tại chứa một tập tin `xmake.lua` + +### Các tuỳ chọn + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | 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` | `['xmake.lua']` | Tên tệp nào sẽ kích hoạt mô-đun này | +| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này | +| `style` | `'bold green'` | Kiểu cho module. | +| `disabled` | `false` | Disables the `xmake` module. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| --------- | -------- | -------------------------------- | +| version | `v2.9.5` | The version of xmake | +| 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 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### Các tuỳ chọn @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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. ### Ví dụ diff --git a/docs/vi-VN/guide/README.md b/docs/vi-VN/guide/README.md index a7af46ff9..85922a0d3 100644 --- a/docs/vi-VN/guide/README.md +++ b/docs/vi-VN/guide/README.md @@ -230,9 +230,10 @@ Hoặc là, cài đặt Starship bằng một package manager bất kì: | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`: +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -Lưu ý: Chỉ hỗ trợ Elvish v0.18+ +Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ Nếu bạn muốn tùy chỉnh Starship nhiều hơn nữa: ## 🤝 Đó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). +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**! 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/). diff --git a/docs/vi-VN/presets/README.md b/docs/vi-VN/presets/README.md index 0e51354be..ddd47f325 100644 --- a/docs/vi-VN/presets/README.md +++ b/docs/vi-VN/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/vi-VN/presets/catppuccin-powerline.md b/docs/vi-VN/presets/catppuccin-powerline.md index 654f52235..aca126295 100644 --- a/docs/vi-VN/presets/catppuccin-powerline.md +++ b/docs/vi-VN/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/vi-VN/presets/pure-preset.md b/docs/vi-VN/presets/pure-preset.md index 77b36f9fd..a92f6ba5d 100644 --- a/docs/vi-VN/presets/pure-preset.md +++ b/docs/vi-VN/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset diff --git a/docs/vi-VN/presets/tokyo-night.md b/docs/vi-VN/presets/tokyo-night.md index af86cdc08..68945efa6 100644 --- a/docs/vi-VN/presets/tokyo-night.md +++ b/docs/vi-VN/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index d466c313b..6f6b81ab0 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - 仅支持 elvish 0.18 及更高的版本。 - - ::: - - 在 `~/.config/fish/rc.elv` 的最后，添加以下内容： + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - 这部分今后可能会改变。 仅支持 Nushell v0.96+。 - - ::: + > [!WARNING] This will change in the future. 仅支持 Nushell v0.96+。 将以下内容添加到你的 Nushell 配置文件的末尾(在 Nushell 中运行 `$nu.config-path` 可以找到该文件)： diff --git a/docs/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md index 146e4cf37..6c8d1afca 100644 --- a/docs/zh-CN/advanced-config/README.md +++ b/docs/zh-CN/advanced-config/README.md @@ -2,15 +2,11 @@ Starship 功能繁多，有时您必须在编辑 `starship.toml` 之外做更多工作才能实现某些效果。 此页面详细介绍了一些在 starship 中使用的高级配置技巧。 -::: warning 警告 - -本节所述的配置内容可能随 Starship 未来版本的更新而改变。 - -::: +> [!WARNING] 本节所述的配置内容可能随 Starship 未来版本的更新而改变。 ## PowerShell 中的 TransientPrompt -可以用自定义字符串替换预设的命令行提示。 这在不经常需要所有提示信息的情况下很有用。 若要启用该功能，请在 shell 中运行 `Enable-TransitientPrompt`命令 若要永久启用该功能，请将 上述语句放在您的 `$PROFILE` 中。 通过在shell中运行 `Disable-TransientPrompt`命令来禁用这项功能。 +可以用自定义字符串替换预设的命令行提示。 这在不经常需要所有提示信息的情况下很有用。 若要启用该功能，请在 shell 中运行 `Enable-TransientPrompt`命令 若要永久启用该功能，请将 上述语句放在您的 `$PROFILE` 中。 通过在shell中运行 `Disable-TransientPrompt`命令来禁用这项功能。 默认情况下，输入的左侧是 `>`符号。 要自定义它，请定义一个新函数，名为 `Invoke-Starship-TransitentFunction`。 例如，要 在这里显示Starship的 `character` 模块，您需要如下操作： diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index 559af5858..6cb5fce7f 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -208,11 +208,7 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts'] | `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | | `follow_symlinks` | `true` | 跟随系统链接检查他们是否是一个路径。在诸如 Git 等组件中使用。 | -::: tip 提示 - -如果你有链接至网络文件系统的符号链接, 建议设置 `follow_symlinks` 为 `false` - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### 示例 @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 字段 | 默认值 | 描述 | @@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu | symbol | | `symbol`对应值 | | style | | `style`对应值 | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### 示例 @@ -681,6 +679,8 @@ format = 'via [$name $version]($style)' The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t | symbol | | `symbol`对应值 | | style | | `style`对应值 | -NB that `version` is not in the default format. - ### Commands The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### 示例 @@ -735,11 +733,7 @@ format = 'via [$name $version]($style)' 默认情况下只会更改颜色。 如果您也想更换字符，请查看 [此示例](#with-custom-error-shape)。 -::: warning 警告 - -`vimcmd_symbol` 仅在 cmd、fish 和 zsh 中支持。 `vimcmd_replace_one_symbol`、`vimcmd_replace_symbol` 和 `vimcmd_visual_symbol` 由于[一个 zsh 模式检测的上游 issue](https://github.com/starship/starship/issues/625#issuecomment-732454148) 仅在 fish 中支持。 - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### 配置项 @@ -855,13 +849,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t `cmd_duration` 组件显示上一个命令执行的用时。 此组件只在命令执行时间长于两秒时显示，或者当其 `min_time` 字段被设置时，按此值为执行时间的显示下限。 -::: warning 不要在 Bash 里捕获 DEBUG 信号 +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -如果您正在 `bash` 上使用 Starship，在运行 `eval $(starship)` 后，不要捕获 `DEBUG` 信号，否则此组件**将会**坏掉。 - -::: - -需要在自动每一条命令前执行某些操作的 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). 只需要在执行 `eval $(starship init $0)` 前简单地定义 `preexec_functions` 和 `precmd_functions` 两个列表，就可以照常运行了。 ### 配置项 @@ -899,11 +891,7 @@ 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. -::: tip 提示 - -此组件没有禁用 conda 自带的提示符修改，您可能需要执行 `conda config --set changeps1 False`。 If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### 配置项 @@ -1206,6 +1194,8 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https:// ### 配置项 -| 选项 | 默认值 | 描述 | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | 组件格式化模板。 | -| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `'blue bold'` | 此组件的样式。 | -| `disabled` | `false` | Disables the `docker_context` module. | +| 选项 | 默认值 | 描述 | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | 组件格式化模板。 | +| `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` | `['compose.yml', 'compose.yaml', '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. | ### 变量 @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - 设置的 `variable` 是一个已存在的环境变量 - 未定义 `variable`，但定义了 `default` -::: tip 提示 +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip 提示 - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### 配置项 @@ -1596,10 +1577,49 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### 配置项 + +| 选项 | 默认值 | 描述 | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 | +| `version_format` | `'${raw}'` | 版本格式 可用的字段有 `raw`, `major`, `minor` 和 `patch` | +| `style` | `'bold purple'` | 此组件的样式。 | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | 触发此组件的扩展名 | +| `detect_files` | `['fpm.toml']` | 触发此组件的文件名 | +| `detect_folders` | `[]` | 触发此组件的文件夹 | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is | +| `disabled` | `false` | Disables the `fortran` module. | + +### 变量 + +| 字段 | 示例 | 描述 | +| --------- | -------- | ----------------------------------- | +| name | gfortran | 编译器的名称 | +| version | `14.2.0` | The version of the Fortran compiler | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | + +*: 此变量只能作为样式字符串的一部分使用 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -1636,6 +1656,8 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -1759,6 +1781,7 @@ very-long-project-name = 'vlpn' | `truncation_symbol` | `'…'` | 此字段的内容用来表示分支名称被截断。 You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | 禁用 `git_branch` 组件。 | ### 变量 @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ### 配置项 @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' `git_status`组件通过相应的符号显示您当前目录中 git 仓库的状态。 -::: 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. - -::: +> [!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. ### 配置项 @@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | -| `stashed` | `'$'` | The format of `stashed` | +| `stashed` | `'\$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning 警告 +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning 警告 - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### 配置项 @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). 默认情况下，此组件将在满足以下任意条件时显示： @@ -2530,21 +2545,13 @@ 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`. -::: tip 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### 配置项 -::: warning 警告 - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | 选项 | 默认值 | 描述 | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2666,6 +2673,8 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -2742,11 +2751,7 @@ format = 'via [🌕 $version](bold blue) ' 默认情况下，如果系统交换区使用不为 0，则会显示交换区使用情况。 -::: tip 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ### 配置项 @@ -2826,6 +2831,8 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -2859,10 +2866,45 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + +### 配置项 + +| 选项 | 默认值 | 描述 | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | 此组件的样式。 | +| `format` | `'\([$state]($style)\) '` | 组件格式化模板。 | +| `disabled` | `true` | Disables the `hg_state` module. | + +### 变量 + +| 字段 | 示例 | 描述 | +| ---------------- | ---------- | ------------------------------ | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | `style`对应值 | + +*: 此变量只能作为样式字符串的一部分使用 + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### 配置项 -| 选项 | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | 此组件的样式。 | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | 触发此组件的扩展名 | -| `detect_files` | `[]` | 触发此组件的文件名 | -| `detect_folders` | `[]` | 触发此组件的文件夹 | +| 选项 | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | 此组件的样式。 | +| `disabled` | `false` | Disables the `odin` module. | +| `detect_extensions` | `['odin']` | 触发此组件的扩展名 | +| `detect_files` | `[]` | 触发此组件的文件名 | +| `detect_folders` | `[]` | 触发此组件的文件夹 | ### 变量 @@ -3277,17 +3319,9 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning 警告 +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ### 配置项 @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## Package Version 包版本 -当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 该组件目前支持 `npm`、`nimble`、`cargo`、`poetry`、`python`、`composer`、`gradle`、`julia`、`mix`、`helm`、`shards`、`daml` 和 `dart` 的软件包。 +当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – `npm` 包版本提取自当前目录中的 `package.json` 文件 - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ Arch = "Arch is the best! " - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip 提示 - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### 配置项 @@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con | `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | 组件格式化模板。 | | `version_format` | `'v${raw}'` | 版本格式 Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | 在环境名之前显示的符号。 | -| `style` | `'yellow bold' | 此组件的样式。 | +| `style` | `'yellow bold'` | 此组件的样式。 | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | | `detect_extensions` | `[]` | 触发此组件的扩展名 | | `detect_files` | `['pixi.toml']` | 触发此组件的文件名 | -| `detect_folders` | `['.pixi']` | 触发此组件的文件夹 | +| `detect_folders` | `[]` | 触发此组件的文件夹 | | `disabled` | `false` | Disables the `pixi` module. | ### 变量 @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip 提示 - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!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). 默认情况下，此组件将在满足以下任意条件时显示： @@ -3712,13 +3742,9 @@ 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` | 禁用 `python` 组件。 | -::: tip 提示 - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -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. - -::: +> [!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. +> +> 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. ### 变量 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ### 配置项 @@ -4088,6 +4110,8 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 + ### 配置项 | 选项 | 默认值 | 描述 | @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' 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 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ### 配置项 @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ### 配置项 @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). 默认情况下，此组件将在满足以下任意条件时显示： @@ -4406,16 +4418,17 @@ By default the Terraform version is not shown, since this is slow for current ve ### 配置项 -| 选项 | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | 版本格式 可用的字段有 `raw`, `major`, `minor` 和 `patch` | -| `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` 组件。 | +| 选项 | 默认值 | 描述 | +| ------------------- | ------------------------------------------------------- | ----------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `version_format` | `'v${raw}'` | 版本格式 可用的字段有 `raw`, `major`, `minor` 和 `patch` | +| `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` 组件。 | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### 变量 @@ -4436,7 +4449,7 @@ By default the Terraform version is not shown, since this is slow for current ve # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## 时间 `time` 组件显示当前的 **本地** 时间。 `format` 字段值会提供给 [`chrono`](https://crates.io/crates/chrono) crate 用来控制时间显示方式。 请参阅 [chrono strftime 文档](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) 以了解可用格式选项。 -::: tip 提示 - -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 - -::: +> [!TIP] This module is disabled by default. 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ### 配置项 @@ -4537,11 +4546,7 @@ By default, the module will be shown if any of the following conditions are met: - 字段 `show_always` 被设置为 true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### 配置项 @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). 默认情况下，此组件将在满足以下任意条件时启用： + +- 当前目录包含 `xmake.lua` 文件 + +### 配置项 + +| 选项 | 默认值 | 描述 | +| ------------------- | ------------------------------------ | --------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 | +| `version_format` | `'v${raw}'` | 版本格式 可用的字段有 `raw`, `major`, `minor` 和 `patch` | +| `symbol` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold green'` | 此组件的样式。 | +| `disabled` | `false` | Disables the `xmake` module. | + +### 变量 + +| 字段 | 示例 | 描述 | +| --------- | -------- | -------------------- | +| version | `v2.9.5` | The version of xmake | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | + +*: 此变量只能作为样式字符串的一部分使用 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 此组件将在符合以下任意条件时显示： @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip 提示 +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 提示 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### 配置项 @@ -4808,17 +4828,15 @@ The `command` (and `when`, if applicable) will be passed in on stdin. shell = ['pwsh', '-Command', '-'] ``` -::: warning 请确保您的自定义 shell 配置正常退出 - -如果您设置了一个自定义命令， 请确保 starship 使用的默认 shell (在 `shell` 选项设置) 执行命令后会正常退出。 - -例如，PowerShell 需要 `-Command` 参数来执行单行命令。 忽略此参数可能导致 starship 无尽递归：shell 可能会尝试加载带有 starship 的完整配置并重新执行自定义命令，导致无尽循环。 - -建议使用类似于 PowerShell 中 `-NoProfile` 的启动参数，这样还能避免额外的配置加载时间。 - -自动检测 shell 和添加适当的参数的功能已被实现，但包含的 shell 支持可能有缺漏。 遇到这种情况，请[提交一个带有 shell 信息和 starship 配置的 issue](https://github.com/starship/starship/issues/new/choose)。 - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index 7d9663180..4042fde1a 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -在 `~/.config/fish/rc.elv` 的最后，添加以下内容： +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -注意：仅支持 v0.18 及以上版本的 Elvish +注意：仅支持 v0.18 及以上版本的 Elvish. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -407,7 +408,7 @@ eval "$(starship init zsh)" ## 🤝 贡献 -我们欢迎 **任何水平** 的参与者！ 如果想练手，可以试着解决某个标记为 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) 的 Issue。 +我们欢迎 **任何水平** 的参与者！ 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/) 上参与翻译。 diff --git a/docs/zh-CN/presets/README.md b/docs/zh-CN/presets/README.md index 866731f86..7a7ff504f 100644 --- a/docs/zh-CN/presets/README.md +++ b/docs/zh-CN/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip 提示 - -在[未来的starship release](https://github.com/starship/starship/pull/3544)中，这一预设将成为默认预设。 - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [点击查看No Nerd Fonts预设](./no-nerd-font) diff --git a/docs/zh-CN/presets/catppuccin-powerline.md b/docs/zh-CN/presets/catppuccin-powerline.md index 6b96d0b0e..e5af809a1 100644 --- a/docs/zh-CN/presets/catppuccin-powerline.md +++ b/docs/zh-CN/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/zh-CN/presets/pure-preset.md b/docs/zh-CN/presets/pure-preset.md index 817283040..bcf6e6ac5 100644 --- a/docs/zh-CN/presets/pure-preset.md +++ b/docs/zh-CN/presets/pure-preset.md @@ -1,4 +1,4 @@ -[返回全部预设](./#pure) +[返回全部预设](./#pure-prompt) # Pure Preset diff --git a/docs/zh-CN/presets/tokyo-night.md b/docs/zh-CN/presets/tokyo-night.md index 3c31f871d..047f1d27c 100644 --- a/docs/zh-CN/presets/tokyo-night.md +++ b/docs/zh-CN/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[返回全部预设](./#pastel-powerline) +[返回全部预设](./#tokyo-night) # Tokyo Night Preset diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index ec21d0b7e..2c438ff7d 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -136,19 +136,16 @@ onMounted(() => { #### Elvish - ::: warning + > [!WARNING] Only elvish v0.18 or higher is supported. - 只有支援 elvish v0.18 或以上版本。 - - ::: - - 將以下內容放到 `~/.elvish/rc.elv` 的結尾： + Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh # ~/.elvish/rc.elv eval (starship init elvish) ``` + For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` #### Tcsh @@ -164,11 +161,7 @@ onMounted(() => { #### Nushell - ::: warning - - 這項設定未來會改變。 只有支援 Nushell v0.96+。 - - ::: + > [!WARNING] This will change in the future. 只有支援 Nushell v0.96+。 Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell): diff --git a/docs/zh-TW/advanced-config/README.md b/docs/zh-TW/advanced-config/README.md index c1631e9da..d5f237226 100644 --- a/docs/zh-TW/advanced-config/README.md +++ b/docs/zh-TW/advanced-config/README.md @@ -2,15 +2,11 @@ 正因為 Starship 是一個多才多藝的 shell，有時候你必須要做比修改 `starship.toml` 更多事情來讓它完成特定工作。 這個頁面說明了一些用於 Starship 的進階設定技巧。 -::: warning - -這個章節內的設定可能會隨著未來 Starship 的版本發行而變動。 - -::: +> [!WARNING] 本章節中的設定檔在未來的 Starship 版本發行時可能會有所變動。 ## TransientPrompt in PowerShell -It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put this statement in your `$PROFILE`. Transience can be disabled on-the-fly with `Disable-TransientPrompt`. +It is possible to replace the previous-printed prompt with a custom string. 這在並非所有提示訊息都需要的情況下會很有用。 To enable this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put this statement in your `$PROFILE`. Transience can be disabled on-the-fly with `Disable-TransientPrompt`. By default, the left side of input gets replaced with `>`. To customize this, define a new function called `Invoke-Starship-TransientFunction`. For example, to display Starship's `character` module here, you would do @@ -26,7 +22,7 @@ Enable-TransientPrompt ## TransientPrompt and TransientRightPrompt in Cmd -Clink allows you to replace the previous-printed prompt with custom strings. This is useful in cases where all the prompt information is not always needed. To enable this, run `clink set prompt.transient ` where \ can be one of: +Clink allows you to replace the previous-printed prompt with custom strings. 這在並非所有提示訊息都需要的情況下會很有用。 To enable this, run `clink set prompt.transient ` where \ can be one of: - `always`: always replace the previous prompt - `same_dir`: replace the previous prompt only if the working directory is same @@ -56,7 +52,7 @@ load(io.popen('starship init cmd'):read("*a"))() ## TransientPrompt and TransientRightPrompt in Fish -It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `enable_transience` in the shell session. To make it permanent, put this statement in your `~/.config/fish/config.fish`. Transience can be disabled on-the-fly with `disable_transience`. +It is possible to replace the previous-printed prompt with a custom string. 這在並非所有提示訊息都需要的情況下會很有用。 如果要啟用這項功能，請在 Shell 工作階段中執行 `enable_transience` 指令。 若要使其永久啟用 ，請將上述指令加入到 `~/.config/fish/config.fish` 中。 你也可以隨時用 `disable_transience` 來臨時關閉這個功能。 Note that in case of Fish, the transient prompt is only printed if the commandline is non-empty, and syntactically correct. diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index c1f212904..47cf9e9c9 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -44,7 +44,7 @@ $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml') ``` -### Logging +### 日誌 在預設值下 starship 會記錄警告以及錯誤至`~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`，其中 session key 對應至您的終端機實例 不過，可以使用 `STARSHIP_CACHE` 環境變數來變更此設定: @@ -72,18 +72,18 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. -### Strings +### 字串 In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`. The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. -| Symbol | Type | Notes | -| ------ | ------------------------- | ------------------------------------------------------ | -| `'` | literal string | less escaping | -| `"` | string | more escaping | -| `'''` | multi-line literal string | less escaping | -| `"""` | multi-line string | more escaping, newlines in declarations can be ignored | +| 符號 | 型別 | 備註 | +| ----- | ------------------------- | ------------------------------------------------------ | +| `'` | literal string | less escaping | +| `"` | 字串 | more escaping | +| `'''` | multi-line literal string | less escaping | +| `"""` | multi-line string | more escaping, newlines in declarations can be ignored | 範例： @@ -140,7 +140,7 @@ A variable contains a `$` symbol followed by the name of the variable. The name - `'$version'` is a format string with a variable named `version`. - `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`. -- `'$git_branch $git_commit'` has the two variables separated with a space. +- #### Text Group @@ -197,22 +197,18 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts'] ### 選項 -| 選項 | 預設 | 說明 | -| ----------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | [連結](#default-prompt-format) | Configure the format of the prompt. | -| `right_format` | `''` | See [Enable Right Prompt](../advanced-config/#enable-right-prompt) | -| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | -| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | -| `add_newline` | `true` | Inserts blank line between shell prompts. | -| `palette` | `''` | Sets which color palette from `palettes` to use. | -| `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | -| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | +| 選項 | 預設 | 說明 | +| ----------------- | ---------------------------- | ------------------------------------------------------------------------------ | +| `format` | [連結](#default-prompt-format) | Configure the format of the prompt. | +| `right_format` | `''` | See [Enable Right Prompt](../advanced-config/#enable-right-prompt) | +| `scan_timeout` | `30` | starship 掃描檔案時的超時（以毫秒為單位）。 | +| `command_timeout` | `500` | starship 執行指令時的超時（以毫秒為單位）。 | +| `add_newline` | `true` | 在 shell 提示字元之間插入空行。 | +| `palette` | `''` | 指定要從 `palettes` 中使用的 palette。 | +| `palettes` | `{}` | palettes 的集合，用來將 <0>colors 指派給使用者自訂的名稱。 請注意 palettes 不能引用自己定義的顏色。 | +| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | -::: tip - -If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. - -::: +> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### 範例 @@ -267,6 +263,7 @@ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$hg_state\ $pijul_channel\ $docker_context\ $package\ @@ -281,6 +278,7 @@ $elixir\ $elm\ $erlang\ $fennel\ +$fortran\ $gleam\ $golang\ $guix_shell\ @@ -372,7 +370,7 @@ When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile | 選項 | 預設 | 說明 | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | 此模組的格式。 | | `symbol` | `'☁️ '` | 顯示在目前 AWS 配置之前的符號。 | | `region_aliases` | `{}` | 除了AWS名稱外，顯示區域別名表 | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | @@ -388,10 +386,10 @@ When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile | region | `ap-northeast-1` | The current AWS region | | profile | `astronauts` | The current AWS profile | | duration | `2h27m20s` | The temporary credentials validity duration | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -442,13 +440,15 @@ Enterprise_Naming_Scheme-voidstars = 'void**' The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 變數 | 預設 | 說明 | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `symbol` | `'󰠅 '` | The symbol used in the format. | -| `style` | `'blue bold'` | The style used in the format. | +| `style` | `'blue bold'` | format 內所使用的風格。 | | `disabled` | `true` | Disables the `azure` module. | | `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. | @@ -493,16 +493,16 @@ very-long-subscription-name = 'vlsn' ### 選項 -| 選項 | 預設 | 說明 | -| -------------------- | --------------------------------- | -------------------------- | -| `full_symbol` | `'󰁹 '` | 當電池充飽時顯示的符號。 | -| `charging_symbol` | `'󰂄 '` | 當電池正在充電時顯示的符號。 | -| `discharging_symbol` | `'󰂃 '` | 當電池正在放電時顯示的符號。 | -| `unknown_symbol` | `'󰁽 '` | 當電池狀態不明時顯示的符號。 | -| `empty_symbol` | `'󰂎 '` | 當電池沒電時顯示的符號。 | -| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | -| `display` | [連結](#battery-display) | 顯示的門檻與模組的風格。 | -| `disabled` | `false` | 停用 `battery` 模組。 | +| 選項 | 預設 | 說明 | +| -------------------- | --------------------------------- | ---------------- | +| `full_symbol` | `'󰁹 '` | 當電池充飽時顯示的符號。 | +| `charging_symbol` | `'󰂄 '` | 當電池正在充電時顯示的符號。 | +| `discharging_symbol` | `'󰂃 '` | 當電池正在放電時顯示的符號。 | +| `unknown_symbol` | `'󰁽 '` | 當電池狀態不明時顯示的符號。 | +| `empty_symbol` | `'󰂎 '` | 當電池沒電時顯示的符號。 | +| `format` | `'[$symbol$percentage]($style) '` | 此模組的格式。 | +| `display` | [連結](#battery-display) | 顯示的門檻與模組的風格。 | +| `disabled` | `false` | 停用 `battery` 模組。 | ### 範例 @@ -564,21 +564,21 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil | `format` | `'with [$symbol($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. | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold blue'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `elixir` module. | +| `disabled` | `false` | 停用 `elixir` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| `version` | `v1.0.0` | The version of `buf` | -| `symbol` | | Mirrors the value of option `symbol` | -| `style`* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| `version` | `v1.0.0` | `buf` 的版本 | +| `symbol` | | 對應 `symbol` 選項的設定值 | +| `style`* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -601,28 +601,28 @@ The `bun` module shows the currently installed version of the [bun](https://bun. | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🥟 '` | A format string representing the symbol of Bun. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['bun.lock', 'bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `symbol` | `'🥟 '` | 用來表示 Bun 符號的格式化字串 | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['bun.lock', 'bun.lockb', 'bunfig.toml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold red'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `bun` module. | +| `disabled` | `false` | 停用 `bun` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v0.1.4` | The version of `bun` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v0.1.4` | `bun` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 -#### Customize the format +#### 自定義格式 ```toml # ~/.config/starship.toml @@ -633,32 +633,30 @@ format = 'via [🍔 $version](bold green) ' ## C -The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. +這個 `c` 模組會顯示您的 C 編譯器相關資訊。 此模組預設會在目前所在的目錄有 `.c` 或 `.h` 檔案時顯示。 ### 選項 | 選項 | 預設 | 說明 | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | +| `format` | `'via [$symbol($version(-$name) )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'C '` | The symbol used before displaying the compiler details | -| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is | +| `detect_extensions` | `['c', 'h']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | 辨識編譯器的方法 (指令)。 | | `style` | `'bold 149'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `c` module. | +| `disabled` | `false` | 停用 `c` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| ------- | ------ | ------------------------------------ | -| name | clang | The name of the compiler | -| version | 13.0.0 | The version of the compiler | -| symbol | | Mirrors the value of option `symbol` | -| style | | Mirrors the value of option `style` | - -NB that `version` is not in the default format. +| 變數 | 範例 | 說明 | +| ------- | ------ | ---------------------- | +| name | clang | 編譯器的名稱 | +| version | 13.0.0 | 編譯器的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style | | 對應 <0>style 選項的設定值 | ### Commands @@ -666,7 +664,7 @@ The `commands` option accepts a list of commands to determine the compiler versi Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +若此模組不支援某個 C 編譯器，您可以透過在 [在 GitHub 提出 Issue](https://github.com/starship/starship/issues/new/choose) 來申請支援。 ### 範例 @@ -679,32 +677,32 @@ format = 'via [$name $version]($style)' ## CPP -The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files. +這個 `cpp` 模組會顯示您的 C 編譯器相關資訊。 此模組預設會在目前所在的目錄有 `.cpp` 、 `.hpp` 或其他 `C++` 相關檔案時顯示。 + +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 | 選項 | 預設 | 說明 | | ------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | +| `format` | `'via [$symbol($version(-$name) )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'C++ '` | The symbol used before displaying the compiler details | -| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | How to detect what the compiler is | +| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | 辨識編譯器的方法 (指令)。 | | `style` | `'bold 149'` | 這個模組的風格。 | -| `disabled` | `true` | Disables the `cpp` module. | +| `disabled` | `true` | 停用`cpp` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| ------- | ------- | ------------------------------------ | -| name | clang++ | The name of the compiler | -| version | 13.0.0 | The version of the compiler | -| symbol | | Mirrors the value of option `symbol` | -| style | | Mirrors the value of option `style` | - -NB that `version` is not in the default format. +| 變數 | 範例 | 說明 | +| ------- | ------- | ---------------------- | +| name | clang++ | 編譯器的名稱 | +| version | 13.0.0 | 編譯器的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style | | 對應 <0>style 選項的設定值 | ### Commands @@ -712,7 +710,7 @@ The `commands` option accepts a list of commands to determine the compiler versi Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. -If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). +If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### 範例 @@ -735,11 +733,7 @@ format = 'via [$name $version]($style)' 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 - -`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). - -::: +> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### 選項 @@ -802,24 +796,24 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | 選項 | 預設 | 說明 | | ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'△ '` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `symbol` | `'△ '` | 顯示在 Cmake 版本之前的符號。 | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold blue'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `cmake` module. | +| `disabled` | `false` | 停用 `cmake` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `v3.17.3` | The version of cmake | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| version | `v3.17.3` | cmake 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ## COBOL / GNUCOBOL @@ -832,36 +826,34 @@ The `cobol` module shows the currently installed version of COBOL. By default, t | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `symbol` | `'⚙️ '` | 顯示在 COBOL 版本之前的符號。 | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `'bold blue'` | 這個模組的風格。 | -| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `disabled` | `false` | Disables the `cobol` module. | +| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `disabled` | `false` | 停用 `cobol` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ---------- | ------------------------------------ | -| version | `v3.1.2.0` | The version of `cobol` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ---------- | ---------------------- | +| version | `v3.1.2.0` | `cobol` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ## 指令持續時間 `cmd_duration` 模組顯示最後一個指令執行所花費的時間。 這個模組只會在指令花費超過兩秒或是有設定 `min_time` 時，超過設定值時出現。 -::: warning 不要在 Bash 中設置 DEBUG trap +> [!WARNING] Do not hook the DEBUG trap in Bash +> +> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. -如果你在 `bash` 中使用 Starship，不要在執行 `eval $(starship init $0)` 之後設置 `DEBUG` trap，不然這個模組**會**壞掉。 - -::: - -想使用類似 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). 只要在 `eval $(starship init $0)` 之前簡單地定義 `preexec_functions` 與 `precmd_functions` 兩個陣列，然後就可以照常進行。 ### 選項 @@ -869,7 +861,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | | `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 | -| `format` | `'took [$duration]($style) '` | The format for the module. | +| `format` | `'took [$duration]($style) '` | 此模組的格式。 | | `style` | `'bold yellow'` | 這個模組的風格。 | | `disabled` | `false` | 停用 `cmd_duration` 模組。 | | `show_notifications` | `false` | Show desktop notifications when command completes. | @@ -881,9 +873,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t | 變數 | 範例 | 說明 | | --------- | -------- | --------------------------------------- | | duration | `16m40s` | The time it took to execute the command | -| style\* | | Mirrors the value of option `style` | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -899,11 +891,7 @@ 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. -::: tip - -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### 選項 @@ -912,20 +900,20 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | `truncation_length` | `1` | 如果環境變數由所`conda create -p [path]`產生時，環境變數的資料夾需要截斷的數目。 `0` 表示不截斷 也請參考 [`directory`](#directory)模組 | | `symbol` | `'🅒 '` | 環境名稱前使用的符號。 | | `style` | `'bold green'` | 這個模組的風格。 | -| `format` | `'via [$symbol$environment]($style) '` | The format for the module. | +| `format` | `'via [$symbol$environment]($style) '` | 此模組的格式。 | | `ignore_base` | `true` | Ignores `base` environment when activated. | | `detect_env_vars` | `["!PIXI_ENVIRONMENT_NAME"]` | Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. | | `disabled` | `false` | 停用 `conda` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| ----------- | ------------ | ------------------------------------ | -| environment | `astronauts` | The current conda environment | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| ----------- | ------------ | ---------------------- | +| environment | `astronauts` | 目前的 conda 環境 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -936,28 +924,28 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c format = '[$symbol$environment](dimmed green) ' ``` -## Container +## 容器 The `container` module displays a symbol and container name, if inside a container. ### 選項 -| 選項 | 預設 | 說明 | -| ---------- | ---------------------------------- | ----------------------------------------- | -| `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. | +| 選項 | 預設 | 說明 | +| ---------- | ---------------------------------- | -------------------------------- | +| `symbol` | `'⬢'` | 在容器內所顯示的符號 | +| `style` | `'bold red dimmed'` | 這個模組的風格。 | +| `format` | `'[$symbol \[$name\]]($style) '` | 此模組的格式。 | +| `disabled` | `false` | Disables the `container` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------------------- | ------------------------------------ | -| name | `fedora-toolbox:35` | The name of the container | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------------------- | ---------------------- | +| name | `fedora-toolbox:35` | 容器的名稱 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -979,24 +967,24 @@ The `crystal` module shows the currently installed version of [Crystal](https:// | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `symbol` | `'🔮 '` | 顯示在 Crystal 版本之前的符號。 | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `'bold red'` | 這個模組的風格。 | -| `detect_extensions` | `['cr']` | Which extensions should trigger this module. | -| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `disabled` | `false` | Disables the `crystal` module. | +| `detect_extensions` | `['cr']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['shard.yml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `disabled` | `false` | 停用 `crystal` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `v0.32.1` | The version of `crystal` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| version | `v0.32.1` | <0>crystal 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1017,24 +1005,24 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'Λ '` | A format string representing the symbol of Daml | | `style` | `'bold cyan'` | 這個模組的風格。 | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `disabled` | `false` | Disables the `daml` module. | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['daml.yaml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `disabled` | `false` | 停用 <0>daml 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v2.2.0` | The version of `daml` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v2.2.0` | `daml` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1057,24 +1045,24 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🎯 '` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. | -| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. | +| `detect_extensions` | `['dart']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['.dart_tool']` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold blue'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `dart` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v2.8.4` | The version of `dart` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v2.8.4` | `dart` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1095,22 +1083,22 @@ The `deno` module shows you your currently installed version of [Deno](https://d | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🦕 '` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `symbol` | `'🦕 '` | 用來表示 Deno 符號的格式化字串 | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'green bold'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `deno` module. | +| `disabled` | `false` | 停用 `deno` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v1.8.3` | The version of `deno` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v1.8.3` | `deno` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | ### 範例 @@ -1135,11 +1123,11 @@ When using the `fish_style_pwd_dir_length` option, instead of hiding the path th | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `truncation_length` | `3` | 到達現在資料夾的路徑中，要被裁減掉的資料夾數目。 | | `truncate_to_repo` | `true` | 是否要裁減到你現在所在的 git 儲存庫的根目錄。 | -| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. | +| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | 此模組的格式。 | | `style` | `'bold cyan'` | 這個模組的風格。 | | `disabled` | `false` | 停用 `directory` 模組。 | -| `read_only` | `'🔒'` | The symbol indicating current directory is read only. | -| `read_only_style` | `'red'` | The style for the read only symbol. | +| `read_only` | `'🔒'` | 代表目前目錄為唯讀的符號。 | +| `read_only_style` | `'red'` | 唯讀符號的風格。 | | `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' | | `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. | | `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. | @@ -1150,7 +1138,7 @@ When using the `fish_style_pwd_dir_length` option, instead of hiding the path th
這個模組有些進階設定選項可以控制顯示資料夾。 -| Advanced Option | 預設 | 說明 | +| 進階選項 | 預設 | 說明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | | `fish_style_pwd_dir_length` | `0` | 當使用 fish shell 的 pwd 路徑邏輯時使用的字元數量。 | @@ -1170,12 +1158,12 @@ When using the `fish_style_pwd_dir_length` option, instead of hiding the path th ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------------------- | ----------------------------------- | -| path | `'D:/Projects'` | The current directory path | -| style\* | `'black bold dimmed'` | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------------------- | ---------------------- | +| path | `'D:/Projects'` | 目前目錄的路徑 | +| style\* | `'black bold dimmed'` | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分
The git repos have additional variables. @@ -1187,7 +1175,7 @@ Let us consider the path `/path/to/home/git_repo/src/lib` | before_root_path | `'/path/to/home/'` | The path before git root directory path | | repo_root | `'git_repo'` | The git root directory name | | path | `'/src/lib'` | The remaining path | -| style | `'black bold dimmed'` | Mirrors the value of option `style` | +| style | `'black bold dimmed'` | 對應 <0>style 選項的設定值 | | repo_root_style | `'underline white'` | Style for git root directory name |
@@ -1206,17 +1194,19 @@ truncation_symbol = '…/' The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | ------------------- | -------------------------------------- | ------------------------------------------------------- | -| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. | +| `format` | `'[$symbol$loaded/$allowed]($style) '` | 此模組的格式。 | | `symbol` | `'direnv '` | The symbol used before displaying the direnv context. | | `style` | `'bold orange'` | 這個模組的風格。 | -| `disabled` | `true` | Disables the `direnv` module. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['.envrc']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `true` | 停用 `direnv` 模組。 | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['.envrc']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `detect_env_vars` | `['DIRENV_FILE']` | Which environment variables should trigger this module. | | `allowed_msg` | `'allowed'` | The message displayed when an rc file is allowed. | | `not_allowed_msg` | `'not allowed'` | The message displayed when an rc file is not_allowed. | @@ -1232,9 +1222,9 @@ The `direnv` module shows the status of the current rc file if one is present. T | allowed | `denied` | Whether the current rc file is allowed. | | rc_path | `/home/test/.envrc` | The current rc file path. | | symbol | | Mirrors the value of option `symbol`. | -| style\* | `red bold` | Mirrors the value of option `style`. | +| style\* | `red bold` | 對應 <0>style 選項的設定值. | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1251,26 +1241,26 @@ The `docker_context` module shows the currently active [Docker context](https:// ### 選項 -| 選項 | 預設 | 說明 | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$context]($style) '` | The format for the module. | -| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `'blue bold'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `docker_context` module. | +| 選項 | 預設 | 說明 | +| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$context]($style) '` | 此模組的格式。 | +| `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` | `['compose.yml', 'compose.yaml', '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` | The current docker context | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------------- | -------------------------- | +| context | `test_context` | The current docker context | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1306,13 +1296,13 @@ The module will also show the Target Framework Moniker (style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1350,23 +1340,23 @@ The `elixir` module shows the currently installed version of [Elixir](https://el | ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | | `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💧 '` | The symbol used before displaying the version of Elixir/Erlang. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['mix.exs']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `'💧 '` | 顯示在 Elixir/Erlang 版本之前的符號。 | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['mix.exs']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold purple'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `elixir` module. | +| `disabled` | `false` | 停用 `elixir` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| ----------- | ------- | ------------------------------------ | -| version | `v1.10` | The version of `elixir` | -| otp_version | | The otp version of `elixir` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| ----------- | ------- | ---------------------- | +| version | `v1.10` | `elixir` 的版本 | +| otp_version | | `elixir` 的 otp 版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1391,24 +1381,24 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang | 選項 | 預設 | 說明 | | ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🌳 '` | A format string representing the symbol of Elm. | -| `detect_extensions` | `['elm']` | Which extensions should trigger this module. | -| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | Which filenames should trigger this module. | -| `detect_folders` | `['elm-stuff']` | Which folders should trigger this modules. | +| `detect_extensions` | `['elm']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['elm-stuff']` | 應觸發此模組的資料夾名稱。 | | `style` | `'cyan bold'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `elm` module. | +| `disabled` | `false` | 停用 `elm` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `v0.19.1` | The version of `elm` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| version | `v0.19.1` | `elm` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1426,26 +1416,17 @@ The `env_var` module displays the current value of a selected environment variab - `variable` 設定選項符合一個存在的環境變數。 - 沒有設定 `variable` 選項，但是有設定 `default` 選項。 -::: tip +> [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. -The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. - -::: - -::: tip - -Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. - -Example: following configuration will display value of USER environment variable - -```toml -# ~/.config/starship.toml - -[env_var.USER] -default = 'unknown user' -``` - -::: +> [!TIP] Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. +> +> Example: following configuration will display value of USER environment variable +> +> ```toml +> +> # ~/.config/starship.toml +> +> [env_var.USER] default = 'unknown user' ``` ### 選項 @@ -1454,7 +1435,7 @@ default = 'unknown user' | `symbol` | `""` | 顯示在變數數值之前的符號。 | | `variable` | | 要顯示的環境變數。 | | `default` | | 在選擇的變數值沒有定義時，顯示的預設值。 | -| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `format` | `"with [$env_value]($style) "` | 此模組的格式。 | | `說明` | `""` | The description of the module that is shown when running `starship explain`. | | `disabled` | `false` | 停用 `env_var` 模組。 | @@ -1463,10 +1444,10 @@ default = 'unknown user' | 變數 | 範例 | 說明 | | --------- | ------------------------------------------- | ------------------------------------------ | | env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | `black bold dimmed` | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | `black bold dimmed` | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1501,24 +1482,24 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `' '` | The symbol used before displaying the version of erlang. | +| `symbol` | `' '` | 顯示在 Erlang 版本之前的符號。 | | `style` | `'bold red'` | 這個模組的風格。 | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['rebar.config', 'elang.mk']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `disabled` | `false` | Disables the `erlang` module. | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['rebar.config', 'elang.mk']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `disabled` | `false` | 停用 `erlang` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `v22.1.3` | The version of `erlang` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| version | `v22.1.3` | <0>erlang 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1539,24 +1520,24 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `style` | `'bold green'` | 這個模組的風格。 | -| `detect_extensions` | `['fnl']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `disabled` | `false` | Disables the `fennel` module. | +| `detect_extensions` | `['fnl']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `disabled` | `false` | 停用 `fennel` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v1.2.1` | The version of `fennel` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v1.2.1` | `fennel` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1577,7 +1558,7 @@ The `fill` module fills any extra space on the line with a symbol. If multiple ` | ---------- | -------------- | --------------------------------- | | `symbol` | `'.'` | The symbol used to fill the line. | | `style` | `'bold black'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `fill` module | +| `disabled` | `false` | 停用 <0>fill 模組。 | ### 範例 @@ -1596,30 +1577,69 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fortran + +The `fortran` module shows the current compiler version of Fortran. + +### 選項 + +| 選項 | 預設 | 說明 | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `symbol` | `' '` | 顯示在 COBOL 版本之前的符號。 | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | +| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `'bold purple'` | 這個模組的風格。 | +| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['fpm.toml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | 辨識編譯器的方法 (指令)。 | +| `disabled` | `false` | Disables the `fortran` module. | + +### 變數 + +| 變數 | 範例 | 說明 | +| --------- | -------- | ----------------------------------- | +| name | gfortran | 編譯器的名稱 | +| version | `14.2.0` | The version of the Fortran compiler | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | + +*: 此變數僅能用於 style 字串的一部分 + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. + +If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | ------------------- | -------------------------------- | ---------------------------------------------------------------------------------- | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `format` | `'on [$symbol$branch]($style) '` | 此模組的格式。 Use `'$branch'` to refer to the current branch name. | | `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | | `style` | `'bold purple'` | 這個模組的風格。 | | `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | | `truncation_symbol` | `'…'` | 用來指示分支名稱被縮減的符號。 You can use `''` for no symbol. | -| `disabled` | `true` | Disables the `fossil_branch` module. | +| `disabled` | `true` | 停用 `fossil_branch` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------- | ------------------------------------ | -| branch | `trunk` | The active Fossil branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------- | ------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1636,11 +1656,13 @@ truncation_symbol = '' The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | -------------------- | ------------------------------------------------------------ | ------------------------------------- | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | 此模組的格式。 | | `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. | @@ -1655,7 +1677,7 @@ The `fossil_metrics` module will show the number of added and deleted lines in t | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1677,7 +1699,7 @@ When the module is enabled it will always be active, unless `detect_env_vars` ha | 選項 | 預設 | 說明 | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | The format for the module. | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | 此模組的格式。 | | `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. | @@ -1694,10 +1716,10 @@ When the module is enabled it will always be active, unless `detect_env_vars` ha | 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 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1752,13 +1774,14 @@ very-long-project-name = 'vlpn' | 選項 | 預設 | 說明 | | -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | 此模組的格式。 Use `'$branch'` to refer to the current branch name. | | `symbol` | `' '` | A format string representing the symbol of git branch. | | `style` | `'bold purple'` | 這個模組的風格。 | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `'…'` | 用來指示分支名稱被縮減的符號。 You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | | `disabled` | `false` | 停用 `git_branch` 模組。 | ### 變數 @@ -1768,10 +1791,10 @@ very-long-project-name = 'vlpn' | 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 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1794,13 +1817,13 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | 選項 | 預設 | 說明 | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | | `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash$tag\)]($style) '` | The format for the module. | +| `format` | `'[\($hash$tag\)]($style) '` | 此模組的格式。 | | `style` | `'bold green'` | 這個模組的風格。 | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | | `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | -| `disabled` | `false` | Disables the `git_commit` module. | +| `disabled` | `false` | 停用 `git_commit` 模組。 | ### 變數 @@ -1808,9 +1831,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | --------- | --------- | -------------------------------------------- | | hash | `b703eb3` | The current git commit hash | | tag | `v1.0.0` | The tag name if showing tag info is enabled. | -| style\* | | Mirrors the value of option `style` | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1838,19 +1861,19 @@ 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)\) '` | The format for the module. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | 此模組的格式。 | | `disabled` | `false` | 停用 `git_state` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| ---------------- | ---------- | ----------------------------------- | -| state | `REBASING` | The current state of the repo | -| progress_current | `1` | The current operation progress | -| progress_total | `2` | The total operation progress | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| ---------------- | ---------- | ------------------------------ | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: tip - -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 @@ -1879,7 +1898,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) )'` | The format for the module. | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | 此模組的格式。 | | `disabled` | `true` | Disables the `git_metrics` module. | | `ignore_submodules` | `false` | Ignore changes to submodules | @@ -1892,7 +1911,7 @@ The `git_metrics` module will show the number of added and deleted lines in the | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' `git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。 -::: 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. - -::: +> [!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. ### 選項 @@ -1920,16 +1935,16 @@ The Git Status module is very slow in Windows directories (for example under `/m | -------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `conflicted` | `'='` | 這個分支有合併衝突。 | -| `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` | +| `ahead` | `'⇡'` | `ahead` 的顯示格式 (符號) | +| `behind` | `'⇣'` | `behind` 的顯示格式 (符號) | +| `diverged` | `'⇕'` | `diverged` 的顯示格式 (符號) | +| `up_to_date` | `''` | `up_to_date` 的顯示格式 (符號) | +| `untracked` | `'?'` | `untracked` 的顯示格式 (符號) | +| `stashed` | `'\$'` | `stashed` 的顯示格式 (符號) | +| `modified` | `'!'` | `modified` 的顯示格式 (符號) | +| `staged` | `'+'` | `staged` 的顯示格式 (符號) | +| `renamed` | `'»'` | `renamed` 的顯示格式 (符號) | +| `deleted` | `'✘'` | `deleted` 的顯示格式 (符號) | | `typechanged` | `""` | The format of `typechanged` | | `style` | `'bold red'` | 這個模組的風格。 | | `ignore_submodules` | `false` | Ignore changes to submodules. | @@ -1943,7 +1958,7 @@ The following variables can be used in `format`: | 變數 | 說明 | | -------------- | ------------------------------------------------------------------------------------------------------------- | -| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` | +| `all_status` | `$conflicted$stashed$deleted$renamed$modified$typechanged$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. | @@ -1953,9 +1968,9 @@ The following variables can be used in `format`: | `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. | | `typechanged` | Displays `typechanged` when a file's type has been changed in the staging area. | -| style\* | Mirrors the value of option `style` | +| style\* | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 The following variables can be used in `diverged`: @@ -2020,23 +2035,23 @@ The `gleam` module shows the currently installed version of [Gleam](https://glea | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'⭐ '` | A format string representing the symbol of Gleam. | -| `detect_extensions` | `['gleam']` | Which extensions should trigger this module. | -| `detect_files` | `['gleam.toml']` | Which filenames should trigger this module. | +| `symbol` | `'⭐ '` | 用來表示 Gleam 符號的格式化字串 | +| `detect_extensions` | `['gleam']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['gleam.toml']` | 應觸發此模組的檔案名稱。 | | `style` | `'bold #FFAFF3'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `gleam` module. | +| `disabled` | `false` | 停用 `gleam` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v1.0.0` | The version of `gleam` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v1.0.0` | `gleam` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2065,12 +2080,12 @@ The `golang` module shows the currently installed version of [Go](https://golang | 選項 | 預設 | 說明 | | ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. | -| `detect_extensions` | `['go']` | Which extensions should trigger this module. | -| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | -| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | +| `detect_extensions` | `['go']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['Godeps']` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold cyan'` | 這個模組的風格。 | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. | | `disabled` | `false` | 停用 `golang` 模組。 | @@ -2079,12 +2094,12 @@ The `golang` module shows the currently installed version of [Go](https://golang | 變數 | 範例 | 說明 | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| version | `v1.12.1` | The version of `go` | +| version | `v1.12.1` | `go` 的版本 | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2112,19 +2127,19 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel | 選項 | 預設 | 說明 | | ---------- | -------------------------- | ------------------------------------------------------ | -| `format` | `'via [$symbol]($style) '` | The format for the module. | +| `format` | `'via [$symbol]($style) '` | 此模組的格式。 | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. | | `style` | `'yellow bold'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `guix_shell` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -- | ------------------------------------ | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -- | ---------------------- | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2151,25 +2166,25 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. | -| `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['gradle']` | Which folders should trigger this module. | +| `detect_extensions` | `['gradle', 'gradle.kts']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['gradle']` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold bright-cyan'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `gradle` module. | | `recursive` | `false` | Enables recursive finding for the `gradle` directory. | ### 變數 -| 變數 | 範例 | 說明 | -| ------- | -------- | ------------------------------------ | -| version | `v7.5.1` | The version of `gradle` | -| symbol | | Mirrors the value of option `symbol` | -| style* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| ------- | -------- | ----------------------- | +| version | `v7.5.1` | The version of `gradle` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ## Haskell @@ -2184,11 +2199,11 @@ By default the module will be shown if any of the following conditions are met: | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | -------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `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. | +| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['stack.yaml', 'cabal.project']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold purple'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `haskell` module. | @@ -2199,10 +2214,10 @@ By default the module will be shown if any of the following conditions are met: | 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` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ## Haxe @@ -2216,24 +2231,24 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o | 選項 | 預設 | 說明 | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['hx', 'hxml']` | Which extensions should trigger this module. | -| `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Which filenames should trigger this module. | -| `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. | -| `symbol` | `'⌘ '` | A format string representing the symbol of Haxe. | +| `detect_extensions` | `['hx', 'hxml']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['.haxelib', 'haxe_libraries']` | 應觸發此模組的資料夾名稱。 | +| `symbol` | `'⌘ '` | 用來表示 Haxe 符號的格式化字串。 | | `style` | `'bold fg:202'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `haxe` module. | +| `disabled` | `false` | 停用 `haxe` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v4.2.5` | The version of `haxe` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v4.2.5` | `haxe` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2255,24 +2270,24 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `symbol` | `'⎈ '` | 用來表示 Helm 符號的格式化字串。 | | `style` | `'bold white'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `helm` module. | +| `disabled` | `false` | 停用 `Helm` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v3.1.1` | The version of `helm` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v3.1.1` | `helm` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2295,7 +2310,7 @@ format = 'via [⎈ $version](bold white) ' | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `trim_at` | `'.'` | 擷取出主機名稱的斷點，以第一個符合的為準。 `'.'` will stop after the first dot. `''` will disable any truncation. | | `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | 此模組的格式。 | | `style` | `'bold dimmed green'` | 這個模組的風格。 | | `disabled` | `false` | 停用 `hostname` 模組。 | | `aliases` | `{}` | Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. | @@ -2305,10 +2320,10 @@ format = 'via [⎈ $version](bold white) ' | 變數 | 範例 | 說明 | | ---------- | ---------- | ----------------------------------------------------- | | 主機名稱 | `computer` | The hostname of the computer | -| style\* | | Mirrors the value of option `style` | +| style\* | | 對應 <0>style 選項的設定值 | | ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2354,24 +2369,24 @@ The `java` module shows the currently installed version of [Java](https://www.or | 選項 | 預設 | 說明 | | ------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. | +| `format` | `'via [${symbol}(${version} )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Which extensions should trigger this module. | -| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `'☕ '` | A format string representing the symbol of Java | +| `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', '.sdkmanrc']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `symbol` | `'☕ '` | 用來表示 Java 符號的格式化字串 | | `style` | `'red dimmed'` | 這個模組的風格。 | | `disabled` | `false` | 停用 `java` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ----- | ------------------------------------ | -| version | `v14` | The version of `java` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ----- | ---------------------- | +| version | `v14` | `java` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2392,17 +2407,9 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +> [!WARNING] This module is not supported on tcsh. -This module is not supported on tcsh and nu. - -::: - -::: warning - -The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. - -::: +> [!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. ### 選項 @@ -2411,7 +2418,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | `threshold`* | `1` | 在超過指定值時顯示工作數量。 | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | -| `format` | `'[$symbol$number]($style) '` | The format for the module. | +| `format` | `'[$symbol$number]($style) '` | 此模組的格式。 | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | 這個模組的風格。 | | `disabled` | `false` | 停用 `jobs` 模組。 | @@ -2420,13 +2427,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --- | ------------------------------------ | -| number | `1` | The number of jobs | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --- | ---------------------- | +| number | `1` | The number of jobs | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2439,6 +2446,14 @@ number_threshold = 4 symbol_threshold = 0 ``` +#### Changing process grouping behavior in fish + +When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: + +```fish +set -g __starship_fish_use_job_groups "false" +``` + ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: @@ -2451,24 +2466,24 @@ The `julia` module shows the currently installed version of [Julia](https://juli | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['jl']` | Which extensions should trigger this module. | -| `detect_files` | `['Project.toml', 'Manifest.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. | +| `detect_extensions` | `['jl']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['Project.toml', 'Manifest.toml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `symbol` | `'ஃ '` | 用來表示 Julia 符號的格式化字串。 | | `style` | `'bold purple'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `julia` module. | +| `disabled` | `false` | 停用 `julia` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v1.4.0` | The version of `julia` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v1.4.0` | `julia` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2489,25 +2504,25 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['kt', 'kts']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. | +| `detect_extensions` | `['kt', 'kts']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `symbol` | `'🅺 '` | 用來表示 Kotlin 符號的格式化字串。 | | `style` | `'bold blue'` | 這個模組的風格。 | | `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `kotlin` module. | +| `disabled` | `false` | 停用 `kotlin` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `v1.4.21` | The version of `kotlin` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| version | `v1.4.21` | <0>kotlin 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2530,32 +2545,24 @@ 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`. -::: tip - -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 - -When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set. - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +> +> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### 選項 -::: warning - -The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. - -::: +> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. | 選項 | 預設 | 說明 | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | 此模組的格式。 | | `style` | `'cyan bold'` | 這個模組的風格。 | | `context_aliases`* | `{}` | Table of context aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `detect_env_vars` | `[]` | Which environmental variables should trigger this module | | `contexts` | `[]` | Customized styles and symbols for specific contexts. | | `disabled` | `true` | Disables the `kubernetes` module. | @@ -2583,10 +2590,10 @@ Note that all regular expression are anchored with `^$` and so must mat | 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 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2666,23 +2673,25 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | ---------- | ------------------------- | ------------------------------------------------------ | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. | -| `format` | `'[$localipv4]($style) '` | The format for the module. | +| `format` | `'[$localipv4]($style) '` | 此模組的格式。 | | `style` | `'bold yellow'` | 這個模組的風格。 | -| `disabled` | `true` | Disables the `localip` module. | +| `disabled` | `true` | 停用 `localip` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------------ | ----------------------------------- | -| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------------ | --------------------------------- | +| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2707,25 +2716,25 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. | -| `detect_extensions` | `['lua']` | Which extensions should trigger this module. | -| `detect_files` | `['.lua-version']` | Which filenames should trigger this module. | -| `detect_folders` | `['lua']` | Which folders should trigger this module. | +| `symbol` | `'🌙 '` | 用來表示 Lua 符號的格式化字串。 | +| `detect_extensions` | `['lua']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['.lua-version']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['lua']` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold blue'` | 這個模組的風格。 | | `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `lua` module. | +| `disabled` | `false` | 停用 `lua` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v5.4.0` | The version of `lua` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v5.4.0` | `lua` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2742,21 +2751,17 @@ format = 'via [🌕 $version](bold blue) ' 預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。 -::: tip - -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 -| 選項 | 預設 | 說明 | -| ----------- | ----------------------------------------------- | -------------------------- | -| `threshold` | `75` | 將記憶體使用量隱藏，除非使用量超過指定值。 | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | The format for the module. | -| `symbol` | `'🐏'` | 顯示在記憶體使用量之前的符號。 | -| `style` | `'bold dimmed white'` | 這個模組的風格。 | -| `disabled` | `true` | 停用 `memory_usage` 模組。 | +| 選項 | 預設 | 說明 | +| ----------- | ----------------------------------------------- | --------------------- | +| `threshold` | `75` | 將記憶體使用量隱藏，除非使用量超過指定值。 | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | 此模組的格式。 | +| `symbol` | `'🐏'` | 顯示在記憶體使用量之前的符號。 | +| `style` | `'bold dimmed white'` | 這個模組的風格。 | +| `disabled` | `true` | 停用 `memory_usage` 模組。 | ### 變數 @@ -2766,8 +2771,8 @@ format = 'via [🌕 $version](bold blue) ' | 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 | `🐏` | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | `🐏` | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | *: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system @@ -2795,20 +2800,20 @@ By default the Meson project name is displayed, if `$MESON_DEVENV` is set. | ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- | | `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. | | `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. | -| `format` | `'via [$symbol$project]($style) '` | The format for the module. | +| `format` | `'via [$symbol$project]($style) '` | 此模組的格式。 | | `symbol` | `'⬢ '` | The symbol used before displaying the project name. | | `style` | `'blue bold'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `meson` module. | +| `disabled` | `false` | 停用 `meson` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ---------- | ------------------------------------ | -| project | `starship` | The current Meson project name | -| symbol | `🐏` | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ---------- | ------------------------------ | +| project | `starship` | The current Meson project name | +| symbol | `🐏` | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2826,27 +2831,29 @@ style = 'bold dimmed green' The `hg_branch` module shows the active branch and topic of the repo in your current directory. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | | `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `style` | `'bold purple'` | 這個模組的風格。 | -| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | 此模組的格式。 | | `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | | `truncation_symbol` | `'…'` | 用來指示分支名稱被縮減的符號。 | -| `disabled` | `true` | Disables the `hg_branch` module. | +| `disabled` | `true` | 停用 `hg_branch` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| topic | `feature` | The active mercurial topic | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | --------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2859,30 +2866,65 @@ truncation_length = 4 truncation_symbol = '' ``` +## Mercurial State + +The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. + +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + +### 選項 + +| 選項 | 預設 | 說明 | +| ------------ | --------------------------- | ------------------------------------------------------------- | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. | +| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. | +| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. | +| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. | +| `style` | `'bold yellow'` | 這個模組的風格。 | +| `format` | `'\([$state]($style)\) '` | 此模組的格式。 | +| `disabled` | `true` | 停用 `hg_state` 模組。 | + +### 變數 + +| 變數 | 範例 | 說明 | +| ---------------- | ---------- | ------------------------------ | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | 對應 <0>style 選項的設定值 | + +*: 此變數僅能用於 style 字串的一部分 + ## Mise The `mise` module shows the current mise health as reported by running `mise doctor`. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | ------------------ | -------------------------------- | ------------------------------------------------ | | `symbol` | `'mise '` | The symbol used before displaying _mise_ health. | | `style` | `'bold purple'` | 這個模組的風格。 | -| `format` | `'on [$symbol$health]($style) '` | The format for the module. | +| `format` | `'on [$symbol$health]($style) '` | 此模組的格式。 | | `healthy_symbol` | `healthy` | The message displayed when _mise_ is healthy. | | `unhealthy_symbol` | `unhealthy` | The message displayed when _mise_ is unhealthy. | -| `disabled` | `true` | Disables the `mise` module. | +| `disabled` | `true` | 停用 `mise` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| health | `healthy` | The health of _mise_ | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| health | `healthy` | The health of _mise_ | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2899,25 +2941,25 @@ The `mojo` module shows the current version of [Mojo programming language](https ### 選項 -| 選項 | 預設 | 說明 | -| ------------------- | ------------------------------------- | ------------------------------------------------------ | -| `format` | `'with [$symbol($version )]($style)'` | The format for the module. | -| `symbol` | `'🔥 '` | The symbol used before displaying the version of Mojo. | -| `style` | `'bold 208'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `mojo` module. | -| `detect_extensions` | `['mojo', '🔥']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| 選項 | 預設 | 說明 | +| ------------------- | ------------------------------------- | ----------------- | +| `format` | `'with [$symbol($version )]($style)'` | 此模組的格式。 | +| `symbol` | `'🔥 '` | 顯示在 Mojo 版本之前的符號。 | +| `style` | `'bold 208'` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `mojo` 模組。 | +| `detect_extensions` | `['mojo', '🔥']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `24.4.0` | The version of `mojo` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `24.4.0` | `mojo` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -2938,16 +2980,16 @@ The `nats` module shows the name of the current [NATS](https://nats.io) context. | ---------- | -------------------------- | ------------------------------------------------------------ | | `symbol` | `'✉️ '` | The symbol used before the NATS context (defaults to empty). | | `style` | `'bold purple'` | 這個模組的風格。 | -| `format` | `'[$symbol$name]($style)'` | The format for the module. | -| `disabled` | `false` | Disables the `nats` module. | +| `format` | `'[$symbol$name]($style)'` | 此模組的格式。 | +| `disabled` | `false` | 停用 `nats` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ----------- | ------------------------------------ | -| name | `localhost` | The name of the NATS context | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ----------- | ---------------------------- | +| name | `localhost` | The name of the NATS context | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | ### 範例 @@ -2965,18 +3007,18 @@ The `netns` module shows the current network namespace. This uses `ip netns iden | 選項 | 預設 | 說明 | | ---------- | --------------------------------- | ----------------------------------------------------------------- | -| `format` | `'[$symbol \[$name\]]($style)'` | The format for the module. | +| `format` | `'[$symbol \[$name\]]($style)'` | 此模組的格式。 | | `symbol` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). | | `style` | `'blue bold dimmed'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `netns` module. | +| `disabled` | `false` | 停用 `netns` 模組。 | ### 變數 | 變數 | 範例 | 說明 | | --------- | ---------- | ----------------------------------------- | | name | `my-netns` | The name of the current network namespace | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | ### 範例 @@ -3003,22 +3045,22 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `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. | -| `detect_files` | `['nim.cfg']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `symbol` | `'👑 '` | 顯示在 Nim 版本之前的符號。 | +| `detect_extensions` | `['nim', 'nims', 'nimble']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['nim.cfg']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold yellow'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `nim` module. | +| `disabled` | `false` | 停用 `nim` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v1.2.0` | The version of `nimc` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v1.2.0` | `nimc` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3038,8 +3080,8 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ | 選項 | 預設 | 說明 | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | 此模組的格式。 | +| `symbol` | `'❄️ '` | 用來表示 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. | @@ -3049,14 +3091,14 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------- | ------------------------------------ | -| 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` | +| 變數 | 範例 | 說明 | +| --------- | ------- | ---------------------- | +| state | `pure` | nix-shell 的狀態 | +| name | `lorri` | nix-shell 的名稱 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3088,12 +3130,12 @@ Additionally, the module will be hidden by default if the directory contains a ` | 選項 | 預設 | 說明 | | ------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `' '` | 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', '.nvmrc']` | Which filenames should trigger this module. | -| `detect_folders` | `['node_modules']` | Which folders should trigger this module. | +| `symbol` | `' '` | 用來表示 Node.js 符號的格式化字串。 | +| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['package.json', '.node-version', '.nvmrc']` | 應觸發此模組的檔案名稱。 | +| `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. | @@ -3102,12 +3144,12 @@ Additionally, the module will be hidden by default if the directory contains a ` | 變數 | 範例 | 說明 | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| version | `v13.12.0` | The version of `node` | +| version | `v13.12.0` | `node` 的版本 | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3133,28 +3175,28 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam | 選項 | 預設 | 說明 | | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string for the module. | +| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. | | `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. | | `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. | -| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Which extensions should trigger this module. | -| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Which filenames should trigger this module. | -| `detect_folders` | `['_opam', 'esy.lock']` | Which folders should trigger this module. | +| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['_opam', 'esy.lock']` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold yellow'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `ocaml` module. | +| `disabled` | `false` | 停用 `ocaml` 模組。 | ### 變數 | 變數 | 範例 | 說明 | | ---------------- | ------------ | ----------------------------------------------------------------- | -| version | `v4.10.0` | The version of `ocaml` | +| version | `v4.10.0` | `ocaml` 的版本 | | switch_name | `my-project` | The active OPAM switch | | switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3171,26 +3213,26 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### 選項 -| 選項 | 預設 | 說明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `show_commit` | `false` | Shows the commit as part of the version. | -| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. | -| `style` | `'bold bright-blue'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `odin` module. | -| `detect_extensions` | `['odin']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| 選項 | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | +| `show_commit` | `false` | Shows the commit as part of the version. | +| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. | +| `style` | `'bold bright-blue'` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `odin` 模組。 | +| `detect_extensions` | `['odin']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------------- | ------------------------------------ | -| version | `dev-2024-03` | The version of `odin` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------------- | ---------------------- | +| version | `dev-2024-03` | `odin` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3210,24 +3252,24 @@ The `opa` module shows the currently installed version of the OPA tool. By defau | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. | -| `detect_extensions` | `['rego']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `symbol` | `'🪖 '` | 用來表示 OPA 符號的格式化字串。 | +| `detect_extensions` | `['rego']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold blue'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `opa` module. | +| `disabled` | `false` | 停用`opa` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `v0.44.0` | The version of `opa` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| version | `v0.44.0` | `opa` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3246,21 +3288,21 @@ The `openstack` module shows the current OpenStack cloud and project. The module | 選項 | 預設 | 說明 | | ---------- | ----------------------------------------------- | -------------------------------------------------------------- | -| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | The format for the module. | +| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | 此模組的格式。 | | `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. | | `style` | `'bold yellow'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `openstack` module. | +| `disabled` | `false` | 停用 `openstack` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------ | ------------------------------------ | -| cloud | `corp` | The current OpenStack cloud | -| project | `dev` | The current OpenStack project | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------ | ----------------------------- | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3277,25 +3319,17 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. -The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. - -::: - -::: tip - -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 | 選項 | 預設 | 說明 | | ---------- | --------------------- | ------------------------------------------------------ | -| `format` | `'[$symbol]($style)'` | The format for the module. | +| `format` | `'[$symbol]($style)'` | 此模組的格式。 | | `style` | `'bold white'` | 這個模組的風格。 | -| `disabled` | `true` | Disables the `os` module. | +| `disabled` | `true` | 停用 `os` 模組。 | | `symbols` | | A table that maps each operating system to its symbol. | `symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https://github.com/starship/starship/issues/new/choose). @@ -3309,6 +3343,7 @@ AlmaLinux = "💠 " Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " +AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " @@ -3352,7 +3387,7 @@ Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " -Void = " " +Void = " " Windows = "🪟 " ``` @@ -3362,13 +3397,13 @@ Windows = "🪟 " | --------- | ------------ | ------------------------------------------------------------------ | | symbol | `🎗️` | The current operating system symbol from advanced option `symbols` | | name | `Arch Linux` | The current operating system name | -| type | `Arch` | The current operating system type | +| 型別 | `Arch` | 目前作業系統的類型 | | codename | | The current operating system codename, if applicable | | edition | | The current operating system edition, if applicable | | version | | The current operating system version, if applicable | -| style\* | | Mirrors the value of option `style` | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3387,7 +3422,7 @@ Arch = "Arch is the best! " ## 套件版本 -The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory @@ -3403,6 +3438,7 @@ The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並 - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory +- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory @@ -3414,7 +3450,7 @@ The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並 | 選項 | 預設 | 說明 | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'is [$symbol$version]($style) '` | The format for the module. | +| `format` | `'is [$symbol$version]($style) '` | 此模組的格式。 | | `symbol` | `'📦 '` | 顯示在套件的版本之前的符號。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | 這個模組的風格。 | @@ -3423,13 +3459,13 @@ The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並 ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v1.0.0` | The version of your package | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | --------------------------- | +| version | `v1.0.0` | The version of your package | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3454,22 +3490,22 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe | 選項 | 預設 | 說明 | | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `['pl', 'pm', 'pod']` | Which extensions should trigger this module. | -| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `symbol` | `'🐪 '` | 顯示在 Perl 版本之前的符號 | +| `detect_extensions` | `['pl', 'pm', 'pod']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold 149'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `perl` module. | +| `disabled` | `false` | 停用 `perl` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `v5.26.1` | The version of `perl` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ---------------------- | +| version | `v5.26.1` | <0>perl 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | ### 範例 @@ -3492,24 +3528,24 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐘 '` | The symbol used before displaying the version of 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. | +| `symbol` | `'🐘 '` | 顯示在 PHP 版本之前的符號。 | +| `detect_extensions` | `['php']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['composer.json', '.php-version']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'147 bold'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `php` module. | +| `disabled` | `false` | 停用`php` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v7.3.8` | The version of `php` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v7.3.8` | `php` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3524,13 +3560,15 @@ format = 'via [🔹 $version](147 bold) ' The `pijul_channel` module shows the active channel of the repo in your current directory. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | | `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | | `style` | `'bold purple'` | 這個模組的風格。 | -| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `format` | `'on [$symbol$channel]($style) '` | 此模組的格式。 | | `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | | `truncation_symbol` | `'…'` | 用來指示分支名稱被縮減的符號。 | | `disabled` | `true` | Disables the `pijul` module. | @@ -3539,35 +3577,31 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. -::: tip - -This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`. - -::: +> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### 選項 | 選項 | 預設 | 說明 | | -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. | | `symbol` | `'🧚 '` | 環境名稱前使用的符號。 | -| `style` | `'yellow bold' | 這個模組的風格。 | +| `style` | `'yellow bold'` | 這個模組的風格。 | | `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. | | `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.pixi']` | Which folders should trigger this module. | -| `disabled` | `false` | Disables the `pixi` module. | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['pixi.toml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `disabled` | `false` | 停用 `pixi` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| ----------- | --------- | ------------------------------------ | -| version | `v0.33.0` | The version of `pixi` | -| environment | `py311` | The current pixi environment | -| symbol | | Mirrors the value of option `symbol` | -| style | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| ----------- | --------- | ---------------------- | +| version | `v0.33.0` | `pixi` 的版本 | +| environment | `py311` | 目前的 pixi 環境 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style | | 對應 <0>style 選項的設定值 | ### 範例 @@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) ' The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip - -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). - -::: +> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the module will be shown if any of the following conditions are met: @@ -3597,24 +3627,24 @@ By default the module will be shown if any of the following conditions are met: | 選項 | 預設 | 說明 | | ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. | +| `format` | `'via [$symbol($username@)$stack]($style) '` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `' '` | A format string shown before the Pulumi stack. | | `style` | `'bold 5'` | 這個模組的風格。 | | `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. | -| `disabled` | `false` | Disables the `pulumi` module. | +| `disabled` | `false` | 停用 `pulumi` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ---------- | ------------------------------------ | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | -| 使用者名稱 | `alice` | The current Pulumi username | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ---------- | --------------------------- | +| version | `v0.12.24` | `pulumi` 的版本 | +| stack | `dev` | The current Pulumi stack | +| 使用者名稱 | `alice` | The current Pulumi username | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3649,24 +3679,24 @@ The `purescript` module shows the currently installed version of [PureScript](ht | 選項 | 預設 | 說明 | | ------------------- | --------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `['purs']` | Which extensions should trigger this module. | -| `detect_files` | `['spago.dhall', 'spago.yaml', 'spago.lock']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['purs']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['spago.dhall', 'spago.yaml', 'spago.lock']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold white'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `purescript` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `0.13.5` | The version of `purescript` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | --------------------------- | +| version | `0.13.5` | The version of `purescript` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3700,33 +3730,29 @@ By default, the module will be shown if any of the following conditions are met: | 選項 | 預設 | 說明 | | -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | 此模組的格式。 | | `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_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 execute when getting the version. | -| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module | -| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `detect_extensions` | `['py', 'ipynb']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `disabled` | `false` | 停用 `python` 模組。 | -::: tip - -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. - -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. - -::: +> [!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. +> +> 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. ### 變數 | 變數 | 範例 | 說明 | | ------------ | --------------- | ------------------------------------------ | | version | `'v3.8.1'` | The version of `python` | -| symbol | `'🐍 '` | Mirrors the value of option `symbol` | -| style | `'yellow bold'` | Mirrors the value of option `style` | +| symbol | `'🐍 '` | 對應 `symbol` 選項的設定值 | +| style | `'yellow bold'` | 對應 <0>style 選項的設定值 | | pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `'venv'` | The current `virtualenv` name | @@ -3769,24 +3795,24 @@ By default, the module will be shown if any of the following conditions are met: | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'⨁ '` | A format string representing the symbol of Quarto | | `style` | `'bold #75AADB'` | 這個模組的風格。 | -| `detect_extensions` | `['.qmd']` | Which extensions should trigger this module. | -| `detect_files` | `['_quarto.yml']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['.qmd']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['_quarto.yml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `disabled` | `false` | Disables the `quarto` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --------- | ------------------------------------ | -| version | `1.4.549` | The version of `quarto` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ----------------------- | +| version | `1.4.549` | The version of `quarto` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ## R @@ -3804,22 +3830,22 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'📐'` | A format string representing the symbol of R. | | `style` | `'blue bold'` | 這個模組的風格。 | -| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Which extensions should trigger this module | -| `detect_files` | `['.Rprofile']` | Which filenames should trigger this module | -| `detect_folders` | `['.Rproj.user']` | Which folders should trigger this module | +| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['.Rprofile']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['.Rproj.user']` | 應觸發此模組的資料夾名稱。 | | `disabled` | `false` | Disables the `r` module. | ### 變數 -| 變數 | 範例 | 說明 | -| ------- | ------------- | ------------------------------------ | -| version | `v4.0.5` | The version of `R` | -| symbol | | Mirrors the value of option `symbol` | -| style | `'blue bold'` | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| ------- | ------------- | ---------------------- | +| version | `v4.0.5` | The version of `R` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style | `'blue bold'` | 對應 <0>style 選項的設定值 | ### 範例 @@ -3841,12 +3867,12 @@ The `raku` module shows the currently installed version of [Raku](https://www.ra | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. | +| `format` | `'via [$symbol($version-$vm_version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku | -| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Which extensions should trigger this module. | -| `detect_files` | `['META6.json']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['META6.json']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold 149'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `raku` module. | @@ -3856,8 +3882,8 @@ The `raku` module shows the currently installed version of [Raku](https://www.ra | ---------- | ------ | ------------------------------------ | | version | `v6.d` | The version of `raku` | | vm_version | `moar` | The version of VM `raku` is built on | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | ### 範例 @@ -3878,24 +3904,24 @@ By default the `red` module shows the currently installed version of [Red](https | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🔺 '` | A format string representing the symbol of Red. | -| `detect_extensions` | `['red']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['red']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'red bold'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `red` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v2.5.1` | The version of `red` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v2.5.1` | The version of `red` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3921,12 +3947,12 @@ Starship gets the current Ruby version by running `ruby -v`. | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'💎 '` | A format string representing the symbol of Ruby. | -| `detect_extensions` | `['rb']` | Which extensions should trigger this module. | -| `detect_files` | `['Gemfile', '.ruby-version']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `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` 模組。 | @@ -3936,11 +3962,11 @@ Starship gets the current Ruby version by running `ruby -v`. | 變數 | 範例 | 說明 | | --------- | -------- | ------------------------------------------- | | version | `v2.5.1` | The version of `ruby` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | | gemset | `test` | Optional, gets the current RVM gemset name. | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -3962,12 +3988,12 @@ By default the `rust` module shows the currently installed version of [Rust](htt | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🦀 '` | A format string representing the symbol of Rust | -| `detect_extensions` | `['rs']` | Which extensions should trigger this module. | -| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['rs']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['Cargo.toml']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold red'` | 這個模組的風格。 | | `disabled` | `false` | 停用 `rust` 模組。 | @@ -3978,10 +4004,10 @@ By default the `rust` module shows the currently installed version of [Rust](htt | version | `v1.43.0-nightly` | The version of `rustc` | | numver | `1.51.0` | The numeric component of the `rustc` version | | toolchain | `beta` | The toolchain version | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4004,24 +4030,24 @@ The `scala` module shows the currently installed version of [Scala](https://www. | 選項 | 預設 | 說明 | | ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. | +| `format` | `'via [${symbol}(${version} )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['sbt', 'scala']` | Which extensions should trigger this module. | -| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Which filenames should trigger this module. | -| `detect_folders` | `['.metals']` | Which folders should trigger this modules. | +| `detect_extensions` | `['sbt', 'scala']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['.metals']` | 應觸發此模組的資料夾名稱。 | | `symbol` | `'🆂 '` | A format string representing the symbol of Scala. | | `style` | `'red dimmed'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `scala` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `2.13.5` | The version of `scala` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `2.13.5` | The version of `scala` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4036,11 +4062,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: tip - -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 @@ -4058,7 +4080,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) '` | The format for the module. | +| `format` | `'[$indicator]($style) '` | 此模組的格式。 | | `style` | `'white bold'` | 這個模組的風格。 | | `disabled` | `true` | Disables the `shell` module. | @@ -4067,9 +4089,9 @@ The `shell` module shows an indicator for currently used shell. | 變數 | 預設 | 說明 | | --------- | -- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| style\* | | 對應 <0>style 選項的設定值. | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4088,12 +4110,14 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 + ### 選項 | 選項 | 預設 | 說明 | | --------------- | ---------------------------- | ------------------------------------------------------------------- | | `threshold` | `2` | Display threshold. | -| `format` | `'[$symbol$shlvl]($style) '` | The format for the module. | +| `format` | `'[$symbol$shlvl]($style) '` | 此模組的格式。 | | `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | | `repeat_offset` | `0` | Decrements number of times `symbol` is repeated by the offset value | @@ -4102,13 +4126,13 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int ### 變數 -| 變數 | 範例 | 說明 | -| --------- | --- | ------------------------------------ | -| shlvl | `3` | The current value of `SHLVL` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --- | ---------------------------- | +| shlvl | `3` | The current value of `SHLVL` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4143,20 +4167,20 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu | 選項 | 預設 | 說明 | | ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. | +| `format` | `'[$symbol\[$env\]]($style) '` | 此模組的格式。 | | `symbol` | `''` | A format string displayed before the image name. | | `style` | `'bold dimmed blue'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `singularity` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current Singularity image | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------------ | ----------------------------- | +| env | `centos.img` | The current Singularity image | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4177,25 +4201,25 @@ The `solidity` module shows the currently installed version of [Solidity](https: | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'S '` | A format string representing the symbol of Solidity | | `compiler | ['solc'] | The default compiler for Solidity. | -| `detect_extensions` | `['sol']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['sol']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold blue'` | 這個模組的風格。 | | `disabled` | `false` | Disables this module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v0.8.1` | The version of `solidity` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ------------------------- | +| version | `v0.8.1` | The version of `solidity` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4216,18 +4240,18 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` 表示不截斷 也請參考 [`directory`](#directory)模組 | | `symbol` | `'🅢 '` | 環境名稱前使用的符號。 | | `style` | `'bold blue'` | 這個模組的風格。 | -| `format` | `'via [$symbol$environment]($style) '` | The format for the module. | +| `format` | `'via [$symbol$environment]($style) '` | 此模組的格式。 | | `disabled` | `false` | Disables the `spack` module. | ### 變數 -| 變數 | 範例 | 說明 | -| ----------- | ------------ | ------------------------------------ | -| environment | `astronauts` | The current spack environment | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| ----------- | ------------ | ----------------------------- | +| environment | `astronauts` | The current spack environment | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) ' 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`。 - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 @@ -4282,10 +4302,10 @@ The `status` module displays the exit code of the previous command. If $success_ | 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' exit codes, this is only available in pipestatus_format | -| symbol | | Mirrors the value of option `symbol` | +| symbol | | 對應 `symbol` 選項的設定值 | | style\* | | Mirrors the value of option `success_style` on program success and `failure_style` otherwise | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4305,11 +4325,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip - -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 @@ -4323,12 +4339,12 @@ The `sudo` module displays if sudo credentials are currently cached. The module ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -- | ------------------------------------ | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -- | ---------------------- | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4361,24 +4377,24 @@ By default the `swift` module shows the currently installed version of [Swift](h | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐦 '` | A format string representing the symbol of Swift | -| `detect_extensions` | `['swift']` | Which extensions should trigger this module. | -| `detect_files` | `['Package.swift']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['swift']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['Package.swift']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'bold 202'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `swift` module. | +| `disabled` | `false` | 停用 `swift` 模組。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v5.2.4` | The version of `swift` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v5.2.4` | `swift` 的版本 | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)' ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. -::: 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). - -::: +> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4406,27 +4418,28 @@ By default the module will be shown if any of the following conditions are met: ### 選項 -| 選項 | 預設 | 說明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | A format string shown before the terraform workspace. | -| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | -| `style` | `'bold 105'` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `terraform` module. | +| 選項 | 預設 | 說明 | +| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol$workspace]($style) '` | 此模組的格式。 | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | +| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `['.terraform']` | 應觸發此模組的資料夾名稱。 | +| `style` | `'bold 105'` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `terraform` module. | +| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ---------- | ------------------------------------ | -| 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` | +| 變數 | 範例 | 說明 | +| --------- | ---------- | ------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met: # ~/.config/starship.toml [terraform] -format = '[🏎💨 $version$workspace]($style) ' +format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version @@ -4445,24 +4458,20 @@ format = '[🏎💨 $version$workspace]($style) ' # ~/.config/starship.toml [terraform] -format = '[🏎💨 $workspace]($style) ' +format = 'via [$symbol$workspace]($style) ' ``` ## 時間 `time` 模組顯示目前的**當地**時間. `format` 設定值被 [`chrono`](https://crates.io/crates/chrono) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。 -::: tip - -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 - -::: +> [!TIP] 此模組預設為停用。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ### 選項 | 選項 | 預設 | 說明 | | ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | The format string for the module. | +| `format` | `'at [$time]($style) '` | 此模組的格式。 | | `use_12hr` | `false` | 啟用 12 小時格式。 | | `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 | | `style` | `'bold yellow'` | 這個模組的時間的風格。 | @@ -4474,12 +4483,12 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ---------- | ----------------------------------- | -| 時間 | `13:08:10` | The current time. | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ---------- | ---------------------- | +| 時間 | `13:08:10` | 目前時間。 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4507,13 +4516,13 @@ By default, the module will be shown if any of the following conditions are met: | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'t '` | A format string representing the symbol of Typst | | `style` | `'bold #0093A7'` | 這個模組的風格。 | -| `detect_extensions` | `['.typ']` | Which extensions should trigger this module. | -| `detect_files` | `['template.typ']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['.typ']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['template.typ']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `disabled` | `false` | Disables the `typst` module. | ### 變數 @@ -4522,10 +4531,10 @@ By default, the module will be shown if any of the following conditions are met: | ------------- | --------- | ----------------------------------------------- | | version | `v0.9.0` | The version of `typst`, alias for typst_version | | typst_version | `default` | The current Typst version | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ## 使用者名稱 @@ -4537,11 +4546,7 @@ By default, the module will be shown if any of the following conditions are met: - 變數 `show_always` 被設為 true - The array `detect_env_vars` contains at least the name of one environment variable, that is set -::: 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. - -::: +> [!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. ### 選項 @@ -4550,7 +4555,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` | `style_root` | `'bold red'` | The style used when the user is root/admin. | | `style_user` | `'bold yellow'` | 非 root 使用者時使用的風格。 | | `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. | -| `format` | `'[$user]($style) in '` | The format for the module. | +| `format` | `'[$user]($style) in '` | 此模組的格式。 | | `show_always` | `false` | 總是顯示 `username` 模組。 | | `disabled` | `false` | 停用 `username` 模組。 | | `aliases` | `{}` | Translate system usernames to something else. | @@ -4588,24 +4593,24 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['Vagrantfile']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['Vagrantfile']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'cyan bold'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `vagrant` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ---------------- | ------------------------------------ | -| version | `Vagrant 2.2.10` | The version of `Vagrant` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ---------------- | ------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4627,22 +4632,22 @@ The `vlang` module shows you your currently installed version of [V](https://vla | 選項 | 預設 | 說明 | | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'V '` | A format string representing the symbol of V | -| `detect_extensions` | `['v']` | Which extensions should trigger this module. | -| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['v']` | 應觸發此模組的副檔名。 | +| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | | `style` | `'blue bold'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `vlang` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------ | ------------------------------------ | -| version | `v0.2` | The version of `v` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------ | ---------------------- | +| version | `v0.2` | The version of `v` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | ### 範例 @@ -4662,18 +4667,18 @@ 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) '` | The format for the module. | +| `format` | `'vcsh [$symbol$repo]($style) '` | 此模組的格式。 | | `disabled` | `false` | Disables the `vcsh` module. | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | ------------------------------------------- | ------------------------------------ | -| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | -| symbol | | Mirrors the value of option `symbol` | -| style\* | `black bold dimmed` | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------------------------------------------- | -------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | `black bold dimmed` | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v format = '[🆅 $repo](bold blue) ' ``` +## XMake + +The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: + +- 目前資料夾中有一個 `xmake.lua` 檔案 + +### 選項 + +| 選項 | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'△ '` | 顯示在 Cmake 版本之前的符號。 | +| `detect_extensions` | `[]` | 應觸發此模組的副檔名。 | +| `detect_files` | `['xmake.lua']` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | +| `style` | `'bold green'` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `xmake` module. | + +### 變數 + +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v2.9.5` | The version of xmake | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | + +*: 此變數僅能用於 style 字串的一部分 + ## Zig By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 這個模組將在下列其中一個條件滿足時顯示： @@ -4694,24 +4728,24 @@ By default the `zig` module shows the currently installed version of [Zig](https | 選項 | 預設 | 說明 | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `format` | `'via [$symbol($version )]($style)'` | 此模組的格式。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. | | `style` | `'bold yellow'` | 這個模組的風格。 | | `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `['zig']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `['zig']` | 應觸發此模組的副檔名。 | +| `detect_files` | `[]` | 應觸發此模組的檔案名稱。 | +| `detect_folders` | `[]` | 應觸發此模組的資料夾名稱。 | ### 變數 -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| version | `v0.6.0` | The version of `zig` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | -------- | ---------------------- | +| version | `v0.6.0` | The version of `zig` | +| symbol | | 對應 `symbol` 選項的設定值 | +| style\* | | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 ### 範例 @@ -4734,31 +4768,17 @@ 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) matches with `os` field if defined. -::: tip +> [!TIP] Multiple custom modules can be defined by using a `.`. -Multiple custom modules can be defined by using a `.`. +> [!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] [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! -::: 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 - -[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 If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. - -Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. - -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). - -::: +> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. +> +> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually 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. +> +> 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). ### 選項 @@ -4775,7 +4795,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `symbol` | `''` | The symbol used before displaying the command output. | | `style` | `'bold green'` | 這個模組的風格。 | -| `format` | `'[$symbol($output )]($style)'` | The format for the module. | +| `format` | `'[$symbol($output )]($style)'` | 此模組的格式。 | | `disabled` | `false` | Disables this `custom` module. | | `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | @@ -4786,10 +4806,10 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | 變數 | 說明 | | --------- | -------------------------------------- | | output | The output of `command` run in `shell` | -| symbol | Mirrors the value of option `symbol` | -| style\* | Mirrors the value of option `style` | +| symbol | 對應 `symbol` 選項的設定值 | +| style\* | 對應 <0>style 選項的設定值 | -*: This variable can only be used as a part of a style string +*: 此變數僅能用於 style 字串的一部分 #### Custom command shell @@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS shell = ['pwsh', '-Command', '-'] ``` -::: warning Make sure your custom shell configuration exits gracefully - -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). - -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. - -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. - -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. - -::: +> [!WARNING] Make sure your custom shell configuration exits gracefully +> +> 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). +> +> 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. +> +> 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. +> +> 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/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index b682a03b4..f8f006a46 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` | +| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | -| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | +| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` | | Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | @@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish -將以下內容放到 `~/.elvish/rc.elv` 的結尾： +Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows): ```sh eval (starship init elvish) ``` -注意：只支援 Elvish v0.18+ 以上的版本 +注意：只支援 Elvish v0.18+ 以上的版本. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
@@ -347,7 +348,7 @@ mkdir ($nu.data-dir | path join "vendor/autoload") starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu") ``` -Note: Only Nushell v0.96+ is supported +注意：只支援 Nushell v0.96+ 的版本
@@ -407,7 +408,7 @@ eval "$(starship init zsh)" ## 🤝 貢獻 -我們歡迎具有**各式各樣能力**的貢獻者！ 如果你正在尋找容易加入的方法，試試看標註為「[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)」的 issue。 +我們歡迎具有**各式各樣能力**的貢獻者！ 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/) 上提交您的翻譯。 @@ -427,14 +428,14 @@ eval "$(starship init zsh)" 你可以[成爲一個贊助者](https://github.com/sponsors/starship)來支持這個專案！ 你的名字和頭像會在這裏顯示，並且會帶有一個前往你網站的鏈接。 -## 🔒 Code Signing Policy +## 🔒 程式碼簽章政策 Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org). Code Signing Roles: -- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts) -- Approvers and Authors: [Mission Control](https://github.com/orgs/starship/teams/mission-control) +- 審查者： [Astronauts](https://github.com/orgs/starship/teams/mission-control) +- 核准者與作者： [Mission Control](https://github.com/orgs/starship/teams/mission-control) This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it. diff --git a/docs/zh-TW/presets/README.md b/docs/zh-TW/presets/README.md index dd75b005f..5cf096eab 100644 --- a/docs/zh-TW/presets/README.md +++ b/docs/zh-TW/presets/README.md @@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip - -This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). - -::: +> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/zh-TW/presets/bracketed-segments.md b/docs/zh-TW/presets/bracketed-segments.md index 50710c442..8bb70bbd7 100644 --- a/docs/zh-TW/presets/bracketed-segments.md +++ b/docs/zh-TW/presets/bracketed-segments.md @@ -12,6 +12,6 @@ starship preset bracketed-segments -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/bracketed-segments.toml){download} +[點擊此處下載 TOML](/presets/toml/bracketed-segments.toml){download} <<< @/public/presets/toml/bracketed-segments.toml diff --git a/docs/zh-TW/presets/catppuccin-powerline.md b/docs/zh-TW/presets/catppuccin-powerline.md index 8b101658a..674f3b1bf 100644 --- a/docs/zh-TW/presets/catppuccin-powerline.md +++ b/docs/zh-TW/presets/catppuccin-powerline.md @@ -1,4 +1,4 @@ -[Return to Presets](./README.md#catppuccin-powerline) +[Return to Presets](./#catppuccin-powerline) # Catppuccin Powerline Preset @@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify - `catppuccin_mocha` - `catppuccin_frappe` - `catppuccin_macchiato` -- `catppucin_latte` +- `catppuccin_latte` [Click to download TOML](/presets/toml/catppuccin-powerline.toml) diff --git a/docs/zh-TW/presets/gruvbox-rainbow.md b/docs/zh-TW/presets/gruvbox-rainbow.md index 5792a9b7f..a35a15fb5 100644 --- a/docs/zh-TW/presets/gruvbox-rainbow.md +++ b/docs/zh-TW/presets/gruvbox-rainbow.md @@ -8,7 +8,7 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an ### 先決要求 -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal +- ### 設定 @@ -16,6 +16,6 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an starship preset gruvbox-rainbow -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/gruvbox-rainbow.toml){download} +[點擊此處下載 TOML](/presets/toml/gruvbox-rainbow.toml){download} <<< @/public/presets/toml/gruvbox-rainbow.toml diff --git a/docs/zh-TW/presets/jetpack.md b/docs/zh-TW/presets/jetpack.md index 7c9f5bb59..c66c5c872 100644 --- a/docs/zh-TW/presets/jetpack.md +++ b/docs/zh-TW/presets/jetpack.md @@ -19,6 +19,6 @@ This is a pseudo minimalist preset inspired by the [geometry](https://github.com starship preset jetpack -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/jetpack.toml){download} +[點擊此處下載 TOML](/presets/toml/jetpack.toml){download} <<< @/public/presets/toml/jetpack.toml diff --git a/docs/zh-TW/presets/nerd-font.md b/docs/zh-TW/presets/nerd-font.md index 6c19abf93..129628ef4 100644 --- a/docs/zh-TW/presets/nerd-font.md +++ b/docs/zh-TW/presets/nerd-font.md @@ -16,6 +16,6 @@ This preset changes the symbols for each module to use Nerd Font symbols. starship preset nerd-font-symbols -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/nerd-font-symbols.toml){download} +[點擊此處下載 TOML](/presets/toml/nerd-font-symbols.toml){download} <<< @/public/presets/toml/nerd-font-symbols.toml diff --git a/docs/zh-TW/presets/no-empty-icons.md b/docs/zh-TW/presets/no-empty-icons.md index ff9ab3e4d..37d8a8360 100644 --- a/docs/zh-TW/presets/no-empty-icons.md +++ b/docs/zh-TW/presets/no-empty-icons.md @@ -12,6 +12,6 @@ If toolset files are identified the toolset icon is displayed. If the toolset is starship preset no-empty-icons -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/no-empty-icons.toml){download} +[點擊此處下載 TOML](/presets/toml/no-empty-icons.toml){download} <<< @/public/presets/toml/no-empty-icons.toml diff --git a/docs/zh-TW/presets/no-nerd-font.md b/docs/zh-TW/presets/no-nerd-font.md index b87666cad..49dbfd4e4 100644 --- a/docs/zh-TW/presets/no-nerd-font.md +++ b/docs/zh-TW/presets/no-nerd-font.md @@ -14,6 +14,6 @@ This preset will become the default preset in a future release of starship. starship preset no-nerd-font -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/no-nerd-font.toml){download} +[點擊此處下載 TOML](/presets/toml/no-nerd-font.toml){download} <<< @/public/presets/toml/no-nerd-font.toml diff --git a/docs/zh-TW/presets/no-runtimes.md b/docs/zh-TW/presets/no-runtimes.md index 4a270b083..b63ee7c72 100644 --- a/docs/zh-TW/presets/no-runtimes.md +++ b/docs/zh-TW/presets/no-runtimes.md @@ -12,6 +12,6 @@ starship preset no-runtime-versions -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/no-runtime-versions.toml){download} +[點擊此處下載 TOML](/presets/toml/no-runtime-versions.toml){download} <<< @/public/presets/toml/no-runtime-versions.toml diff --git a/docs/zh-TW/presets/pastel-powerline.md b/docs/zh-TW/presets/pastel-powerline.md index 099d4528d..a571ee106 100644 --- a/docs/zh-TW/presets/pastel-powerline.md +++ b/docs/zh-TW/presets/pastel-powerline.md @@ -16,6 +16,6 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m starship preset pastel-powerline -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/pastel-powerline.toml){download} +[點擊此處下載 TOML](/presets/toml/pastel-powerline.toml){download} <<< @/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 2b9666779..a797df578 100644 --- a/docs/zh-TW/presets/plain-text.md +++ b/docs/zh-TW/presets/plain-text.md @@ -12,6 +12,6 @@ This preset changes the symbols for each module into plain text. Great if you do starship preset plain-text-symbols -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/plain-text-symbols.toml){download} +[點擊此處下載 TOML](/presets/toml/plain-text-symbols.toml){download} <<< @/public/presets/toml/plain-text-symbols.toml diff --git a/docs/zh-TW/presets/pure-preset.md b/docs/zh-TW/presets/pure-preset.md index e34b50434..c85f0ffb7 100644 --- a/docs/zh-TW/presets/pure-preset.md +++ b/docs/zh-TW/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pure) +[Return to Presets](./#pure-prompt) # Pure Preset @@ -12,6 +12,6 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso starship preset pure-preset -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/pure-preset.toml){download} +[點擊此處下載 TOML](/presets/toml/pure-preset.toml){download} <<< @/public/presets/toml/pure-preset.toml diff --git a/docs/zh-TW/presets/tokyo-night.md b/docs/zh-TW/presets/tokyo-night.md index 3b211ee9c..64e504bbd 100644 --- a/docs/zh-TW/presets/tokyo-night.md +++ b/docs/zh-TW/presets/tokyo-night.md @@ -1,4 +1,4 @@ -[Return to Presets](./#pastel-powerline) +[Return to Presets](./#tokyo-night) # Tokyo Night Preset @@ -8,7 +8,7 @@ This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/t ### 先決要求 -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal +- ### 設定 @@ -16,6 +16,6 @@ This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/t starship preset tokyo-night -o ~/.config/starship.toml ``` -[Click to download TOML](/presets/toml/tokyo-night.toml){download} +[點擊此處下載 TOML](/presets/toml/tokyo-night.toml){download} <<< @/public/presets/toml/tokyo-night.toml