diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index 238c55d4e..710ffb9da 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -46,7 +46,8 @@ os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\star ### 로그 -기본적으로 Starship은 경고 및 오류를 `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`라는 파일에 기록합니다. 여기서 세션 키는 터미널 인스턴스에 해당합니다. 하지만 이는 `STARSHIP_CACHE` 환경 변수를 사용하여 변경할 수 있습니다. +기본적으로 Starship은 경고 및 오류를 `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`라는 파일에 기록합니다. 여기서 세션 키는 터미널 인스턴스에 해당합니다. +하지만 이는 `STARSHIP_CACHE` 환경 변수를 사용하여 변경할 수 있습니다. ```sh export STARSHIP_CACHE=~/.starship/cache @@ -98,7 +99,8 @@ format = "☺\\☻ " format = '\[\$\] ' ``` -줄 바꿈을 사용할 때는 여러 줄로 된 선언을 사용할 수 있습니다. 예를 들어, `$` 기호를 새 줄에 출력하려면 `format`에 다음 값들을 사용하면 동일한 효과를 얻을 수 있습니다: +줄 바꿈을 사용할 때는 여러 줄로 된 선언을 사용할 수 있습니다. +예를 들어, `$` 기호를 새 줄에 출력하려면 `format`에 다음 값들을 사용하면 동일한 효과를 얻을 수 있습니다: ```toml # with literal string @@ -130,11 +132,14 @@ line2 ### 포멧 문자열 -포맷 문자열은 모듈이 모든 변수를 출력하는 데 사용하는 형식입니다. 대부분의 모듈에는 모듈의 표시 형식을 구성하는 `format`이라는 항목이 있습니다. 형식 문자열에서 텍스트, 변수 및 텍스트 그룹을 사용할 수 있습니다. +포맷 문자열은 모듈이 모든 변수를 출력하는 데 사용하는 형식입니다. +대부분의 모듈에는 모듈의 표시 형식을 구성하는 `format`이라는 항목이 있습니다. +형식 문자열에서 텍스트, 변수 및 텍스트 그룹을 사용할 수 있습니다. #### -A variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`. +A variable contains a `$` symbol followed by the name of the variable. +The name of a variable can only contain letters, numbers and `_`. 예를 들어: @@ -146,7 +151,8 @@ A variable contains a `$` symbol followed by the name of the variable. The name A text group is made up of two different parts. -The first part, which is enclosed in a `[]`, is a [format string](#format-strings). You can add texts, variables, or even nested text groups in it. +The first part, which is enclosed in a `[]`, is a [format string](#format-strings). +You can add texts, variables, or even nested text groups in it. In the second part, which is enclosed in a `()`, is a [style string](#style-strings). This can be used to style the first part. @@ -177,7 +183,8 @@ A conditional format string wrapped in `(` and `)` will not render if all variab - `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region. - `'(some text)'` will always show nothing since there are no variables wrapped in the braces. -- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`. +- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. + This works the same as `'(\[$a$b\] )'`. ### Negative matching @@ -197,16 +204,16 @@ This is the list of prompt-wide configuration options. ### Options -| Option | Default | Description | -| ----------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | [link](#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. | +| Option | Default | Description | +| ----------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `format` | [link](#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. | +| `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`. @@ -359,9 +366,11 @@ format = '$all$directory$character' ## AWS -The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. +The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. +The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -375,8 +384,8 @@ When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile ### Options -| Option | Default | Description | -| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. | | `기호` | `'☁️ '` | The symbol used before displaying the current AWS profile. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | @@ -388,15 +397,15 @@ When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile ### Variables -| | 예시 | Description | -| --------- | ---------------- | ------------------------------------------- | -| region | `ap-northeast-1` | The current AWS region | -| profile | `astronauts` | The current AWS profile | -| duration | `2h27m20s` | The temporary credentials validity duration | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| | 예시 | Description | +| -------- | ---------------- | ------------------------------------------- | +| region | `ap-northeast-1` | The current AWS region | +| profile | `astronauts` | The current AWS profile | +| duration | `2h27m20s` | The temporary credentials validity duration | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -447,14 +456,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] 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 -| | Default | Description | -| ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- | +| | Default | Description | +| ---------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | -| `기호` | `'󰠅 '` | The symbol used in the format. | +| `기호` | `'󰠅 '` | The symbol used in the format. | | `style` | `'blue bold'` | The style used in the format. | | `disabled` | `true` | Disables the `azure` module. | | `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. | @@ -496,17 +506,18 @@ very-long-subscription-name = 'vlsn' ## Battery -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +The `battery` module shows how charged the device's battery is and its current charging status. +The module is only visible when the device's battery is below 10%. ### Options -| Option | Default | Description | -| -------------------- | --------------------------------- | --------------------------------------------------- | -| `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. | -| `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. | -| `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. | -| `unknown_symbol` | `'󰂑 '` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. | +| Option | Default | Description | +| -------------------- | --------------------------------- | ------------------------------------------------------------------- | +| `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. | +| `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. | +| `unknown_symbol` | `'󰂑 '` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. | | `disabled` | `false` | Disables the `battery` module. | @@ -524,7 +535,8 @@ discharging_symbol = '💀 ' ### Battery Display -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. The default is as shown: +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). +If no `display` is provided. The default is as shown: ```toml [[battery.display]] @@ -538,8 +550,8 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r The `display` option is an array of the following table. -| Option | Default | Description | -| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- | +| Option | Default | Description | +| -------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------- | | `threshold` | `10` | The upper bound for the display option. | | `style` | `'red bold'` | The style used if the display option is in use. | | `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | @@ -566,11 +578,11 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil ### Options -| Option | Default | Description | -| ------------------- | ----------------------------------------------- | ----------------------------------------------------- | +| Option | Default | Description | +| ------------------- | ----------------------------------------------- | --------------------------------------------------------------------- | | `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. | | `version_format` | `'v${raw}'` | The version format. | -| `기호` | `'🐃 '` | The symbol used before displaying the version of Buf. | +| `기호` | `'🐃 '` | 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 module. | @@ -583,9 +595,9 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil | --------- | -------- | ------------------------------------ | | `version` | `v1.0.0` | The version of `buf` | | `기호` | | Mirrors the value of option `symbol` | -| `style`* | | Mirrors the value of option `style` | +| `style`\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -598,7 +610,8 @@ symbol = '🦬 ' ## Bun -The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. By default the module will be shown if any of the following conditions are met: +The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. +By default the module will be shown if any of the following conditions are met: - The current directory contains a `bun.lock` file - The current directory contains a `bun.lockb` file @@ -606,26 +619,26 @@ The `bun` module shows the currently installed version of the [bun](https://bun. ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🥟 '` | 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. | -| `style` | `'bold red'` | The style for the module. | -| `disabled` | `false` | Disables the `bun` module. | +| `기호` | `'🥟 '` | 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. | +| `style` | `'bold red'` | The style for the module. | +| `disabled` | `false` | Disables the `bun` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v0.1.4` | The version of `bun` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v0.1.4` | The version of `bun` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -644,26 +657,26 @@ The `c` module shows some information about your C compiler. By default the modu ### Options -| Option | Default | Description | -| ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'C '` | The symbol used before displaying the compiler details | -| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is | -| `style` | `'bold 149'` | The style for the module. | -| `disabled` | `false` | Disables the `c` module. | +| `기호` | `'C '` | The symbol used before displaying the compiler details | +| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is | +| `style` | `'bold 149'` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | ### Variables -| | 예시 | Description | -| ------- | ------ | ------------------------------------ | -| name | clang | The name of the compiler | +| | 예시 | Description | +| ------- | -------------------------------------- | ------------------------------------ | +| name | clang | The name of the compiler | | version | 13.0.0 | The version of the compiler | -| 기호 | | Mirrors the value of option `symbol` | -| style | | Mirrors the value of option `style` | +| 기호 | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | ### Commands @@ -686,30 +699,31 @@ 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'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 | -| `style` | `'bold 149'` | The style for the module. | -| `disabled` | `true` | Disables the `cpp` module. | +| `기호` | `'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 | +| `style` | `'bold 149'` | The style for the module. | +| `disabled` | `true` | Disables the `cpp` module. | ### Variables -| | 예시 | Description | -| ------- | ------- | ------------------------------------ | -| name | clang++ | The name of the compiler | -| version | 13.0.0 | The version of the compiler | -| 기호 | | Mirrors the value of option `symbol` | -| style | | Mirrors the value of option `style` | +| | 예시 | Description | +| ------- | -------------------------------------- | ------------------------------------ | +| name | clang++ | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| 기호 | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | ### Commands @@ -740,12 +754,13 @@ 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 -| Option | Default | Description | -| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- | +| Option | Default | Description | +| --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------- | | `format` | `'$symbol '` | The format string used before the text input. | | `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. | | `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. | @@ -757,8 +772,8 @@ By default it only changes color. If you also want to change its shape take a lo ### Variables -| | 예시 | Description | -| -- | -- | -------------------------------------------------------------------------------------------------------- | +| | 예시 | Description | +| -- | -- | ------------------------------------------------------------------------------------------------------------------------ | | 기호 | | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. | ### 예시 @@ -801,88 +816,91 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `'bold blue'` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| `기호` | `'△ '` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `'bold blue'` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| version | `v3.17.3` | The version of cmake | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| version | `v3.17.3` | The version of cmake | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## COBOL / GNUCOBOL -The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met: +The `cobol` module shows the currently installed version of COBOL. +By default, the module will be shown if any of the following conditions are met: - The current directory contains any files ending in `.cob` or `.COB` - The current directory contains any files ending in `.cbl` or `.CBL` ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `기호` | `'⚙️ '` | The symbol used before displaying the version of COBOL. | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------- | +| `기호` | `'⚙️ '` | The symbol used before displaying the version of COBOL. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `style` | `'bold blue'` | The style for the module. | -| `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. | +| `style` | `'bold blue'` | The style for the module. | +| `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. | ### Variables -| | 예시 | Description | -| --------- | ---------- | ------------------------------------ | -| version | `v3.1.2.0` | The version of `cobol` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ---------- | ------------------------------------ | +| version | `v3.1.2.0` | The version of `cobol` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## 명령 지속 시간 -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. +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. -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). +Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Options -| Option | Default | Description | -| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | -| `format` | `'took [$duration]($style) '` | The format for the module. | -| `style` | `'bold yellow'` | The style for the module. | -| `disabled` | `false` | Disables the `cmd_duration` module. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | +| Option | Default | Description | +| ---------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | +| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `format` | `'took [$duration]($style) '` | The format for the module. | +| `style` | `'bold yellow'` | The style for the module. | +| `disabled` | `false` | Disables the `cmd_duration` module. | +| `show_notifications` | `false` | Show desktop notifications when command completes. | +| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | ### Variables -| | 예시 | Description | -| --------- | -------- | --------------------------------------- | -| duration | `16m40s` | The time it took to execute the command | -| style\* | | Mirrors the value of option `style` | +| | 예시 | Description | +| -------- | -------- | --------------------------------------- | +| duration | `16m40s` | The time it took to execute the command | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -898,19 +916,20 @@ 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 shell.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 -| Option | Default | Description | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `기호` | `'🅒 '` | The symbol used before the environment name. | -| `style` | `'bold green'` | The style for the module. | -| `format` | `'via [$symbol$environment]($style) '` | The format for the module. | -| `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` | Disables the `conda` module. | +| `기호` | `'🅒 '` | The symbol used before the environment name. | +| `style` | `'bold green'` | The style for the module. | +| `format` | `'via [$symbol$environment]($style) '` | The format for the module. | +| `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` | Disables the `conda` module. | ### Variables @@ -918,9 +937,9 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e | ----------- | ------------ | ------------------------------------ | | environment | `astronauts` | The current conda environment | | 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -937,22 +956,22 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ----------------------------------------- | -| `기호` | `'⬢'` | The symbol shown, when inside a container | -| `style` | `'bold red dimmed'` | The style for the module. | -| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Default | Description | +| ---------- | ---------------------------------- | ------------------------------------------------ | +| `기호` | `'⬢'` | The symbol shown, when inside a container | +| `style` | `'bold red dimmed'` | The style for the module. | +| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables -| | 예시 | Description | -| --------- | ------------------- | ------------------------------------ | -| name | `fedora-toolbox:35` | The name of the container | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------------------- | ------------------------------------ | +| name | `fedora-toolbox:35` | The name of the container | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -965,33 +984,34 @@ format = '[$symbol \[$name\]]($style) ' ## Crystal -The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `기호` | `'🔮 '` | The symbol used before displaying the version of crystal. | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------- | +| `기호` | `'🔮 '` | The symbol used before displaying the version of crystal. | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `style` | `'bold red'` | The style for the module. | -| `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. | +| `style` | `'bold red'` | The style for the module. | +| `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. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| version | `v0.32.1` | The version of `crystal` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| version | `v0.32.1` | The version of `crystal` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1004,32 +1024,33 @@ format = 'via [✨ $version](bold blue) ' ## Daml -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. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. By default the module will be shown if any of the following conditions are met: +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. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. +By default the module will be shown if any of the following conditions are met: - The current directory contains a `daml.yaml` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'Λ '` | A format string representing the symbol of Daml | -| `style` | `'bold cyan'` | The style for the module. | -| `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. | +| `기호` | `'Λ '` | A format string representing the symbol of Daml | +| `style` | `'bold cyan'` | The style for the module. | +| `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. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v2.2.0` | The version of `daml` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v2.2.0` | The version of `daml` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1042,7 +1063,8 @@ format = 'via [D $version](bold bright-green) ' ## Dart -The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -1050,26 +1072,26 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🎯 '` | 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. | -| `style` | `'bold blue'` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| `기호` | `'🎯 '` | 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. | +| `style` | `'bold blue'` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v2.8.4` | The version of `dart` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v2.8.4` | The version of `dart` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1082,29 +1104,30 @@ format = 'via [🔰 $version](bold red) ' ## Deno -The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🦕 '` | 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. | -| `style` | `'green bold'` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| `기호` | `'🦕 '` | 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. | +| `style` | `'green bold'` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v1.8.3` | The version of `deno` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v1.8.3` | The version of `deno` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | ### 예시 @@ -1126,40 +1149,40 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an ### Options -| Option | Default | Description | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. | -| `style` | `'bold cyan'` | The style for the module. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `'🔒'` | The symbol indicating current directory is read only. | -| `read_only_style` | `'red'` | The style for the read only symbol. | +| Option | Default | Description | +| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | +| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. | +| `style` | `'bold cyan'` | The style for the module. | +| `disabled` | `false` | Disables the `directory` module. | +| `read_only` | `'🔒'` | The symbol indicating current directory is read only. | +| `read_only_style` | `'red'` | The style for the read only symbol. | | `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' | | `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`. | -| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. | -| `home_symbol` | `'~'` | The symbol indicating home directory. | -| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) | +| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. | +| `home_symbol` | `'~'` | The symbol indicating home directory. | +| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) | -
-This module has a few advanced configuration options that control how the directory is displayed. +
This module has a few advanced configuration options that control how the directory is displayed. -| Advanced Option | Default | Description | -| --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `substitutions` | | An Array or table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| Advanced Option | Default | Description | +| --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `substitutions` | | An Array or table of substitutions to be made to the path. | +| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD. It takes an array of the following key/value pairs: -| Value | 종류 | Description | -| ------- | ------- | ---------------------------------------- | -| `from` | String | The value to substitute | -| `to` | String | The replacement for that value, if found | -| `regex` | Boolean | (Optional) Whether `from` is a regex | +| Value | 종류 | Description | +| ------- | ------- | ------------------------------------------------------- | +| `from` | String | The value to substitute | +| `to` | String | The replacement for that value, if found | +| `regex` | Boolean | (Optional) Whether `from` is a regex | -By using `regex = true`, you can use [Rust's regular expressions](https://docs.rs/regex/latest/regex/#syntax) in `from`. For instance you can replace every slash except the first with the following: +By using `regex = true`, you can use [Rust's regular expressions](https://docs.rs/regex/latest/regex/#syntax) in `from`. +For instance you can replace every slash except the first with the following: ```toml substitutions = [ @@ -1185,24 +1208,23 @@ The old syntax still works, although it doesn't support regular expressions: ### Variables -| | 예시 | Description | -| --------- | --------------------- | ----------------------------------- | -| path | `'D:/Projects'` | The current directory path | +| | 예시 | Description | +| ------- | --------------------- | ----------------------------------- | +| path | `'D:/Projects'` | The current directory path | | style\* | `'black bold dimmed'` | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string -
-The git repos have additional variables. +
The git repos have additional variables. Let us consider the path `/path/to/home/git_repo/src/lib` -| | 예시 | Description | -| ------------------ | --------------------- | --------------------------------------- | +| | 예시 | Description | +| ---------------------------------------------------------- | --------------------- | --------------------------------------- | | before_root_path | `'/path/to/home/'` | The path before git root directory path | -| repo_root | `'git_repo'` | The git root directory name | -| path | `'/src/lib'` | The remaining path | -| style | `'black bold dimmed'` | Mirrors the value of option `style` | +| 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` | | repo_root_style | `'underline white'` | Style for git root directory name |
@@ -1221,37 +1243,38 @@ 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | ------------------------------------------------------- | -| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. | -| `기호` | `'direnv '` | The symbol used before displaying the direnv context. | -| `style` | `'bold orange'` | The style for the module. | -| `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. | -| `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. | -| `denied_msg` | `'denied'` | The message displayed when an rc file is denied. | -| `loaded_msg` | `'loaded'` | The message displayed when an rc file is loaded. | -| `unloaded_msg` | `'not loaded'` | The message displayed when an rc file is not loaded. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------ | +| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. | +| `기호` | `'direnv '` | The symbol used before displaying the direnv context. | +| `style` | `'bold orange'` | The style for the module. | +| `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. | +| `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. | +| `denied_msg` | `'denied'` | The message displayed when an rc file is denied. | +| `loaded_msg` | `'loaded'` | The message displayed when an rc file is loaded. | +| `unloaded_msg` | `'not loaded'` | The message displayed when an rc file is not loaded. | ### Variables -| | 예시 | Description | -| --------- | ------------------- | --------------------------------------- | -| loaded | `loaded` | Whether the current rc file is loaded. | -| allowed | `denied` | Whether the current rc file is allowed. | -| rc_path | `/home/test/.envrc` | The current rc file path. | -| 기호 | | Mirrors the value of option `symbol`. | -| style\* | `red bold` | Mirrors the value of option `style`. | +| | 예시 | Description | +| ---------------------------- | ------------------- | ------------------------------------------------------- | +| loaded | `loaded` | Whether the current rc file is loaded. | +| allowed | `denied` | Whether the current rc file is allowed. | +| rc_path | `/home/test/.envrc` | The current rc file path. | +| 기호 | | Mirrors the value of option `symbol`. | +| style\* | `red bold` | Mirrors the value of option `style`. | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1268,26 +1291,26 @@ 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 | +| 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. | +| `style` | `'blue bold'` | The style for the module. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables -| | 예시 | Description | -| --------- | -------------- | ------------------------------------ | -| context | `test_context` | The current docker context | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------------- | ------------------------------------ | +| context | `test_context` | The current docker context | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1321,28 +1344,28 @@ The module will also show the Target Framework Moniker ( [!TIP] The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. +> [!TIP] 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' ``` +> ``` ### Options -| Option | Default | Description | -| ------------- | ------------------------------------- | ---------------------------------------------------------------------------- | +| Option | Default | Description | +| ------------- | ------------------------------------- | -------------------------------------------------------------------------------------------- | | `기호` | `""` | The symbol used before displaying the variable value. | | `variable` | | The environment variable to be displayed. | | `default` | | The default value to be displayed when the selected variable is not defined. | | `format` | `"with [$symbol$env_value]($style) "` | The format for the module. | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `disabled` | `false` | Disables the `env_var` module. | | `style` | `"black bold dimmed"` | The style for the module. | ### Variables -| | 예시 | Description | -| --------- | ------------------------------------------- | ------------------------------------------ | +| | 예시 | Description | +| ------------------------------ | -------------------------------------------------------------- | ------------------------------------------ | | env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1501,33 +1529,34 @@ default = 'unknown user' ## Erlang -The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: +The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `rebar.config` file. - The current directory contains a `erlang.mk` file. ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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 displaying the version of erlang. | -| `style` | `'bold red'` | The style for the module. | -| `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 module. | -| `disabled` | `false` | Disables the `erlang` module. | +| `기호` | `' '` | The symbol used before displaying the version of erlang. | +| `style` | `'bold red'` | The style for the module. | +| `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 module. | +| `disabled` | `false` | Disables the `erlang` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| version | `v22.1.3` | The version of `erlang` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| version | `v22.1.3` | The version of `erlang` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1540,32 +1569,33 @@ format = 'via [e $version](bold red) ' ## Fennel -The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). +By default the module will be shown if any of the following conditions are met: - The current directory contains a file with the `.fnl` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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 displaying the version of fennel. | -| `style` | `'bold green'` | The style for the module. | -| `detect_extensions` | `['fnl']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `disabled` | `false` | Disables the `fennel` module. | +| `기호` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `['fnl']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `fennel` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v1.2.1` | The version of `fennel` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1582,11 +1612,11 @@ The `fill` module fills any extra space on the line with a symbol. If multiple ` ### Options -| Option | Default | Description | -| ---------- | -------------- | --------------------------------- | +| Option | Default | Description | +| ---------- | -------------- | ------------------------------------------------- | | `기호` | `'.'` | The symbol used to fill the line. | | `style` | `'bold black'` | The style for the module. | -| `disabled` | `false` | Disables the `fill` module | +| `disabled` | `false` | Disables the `fill` module | ### 예시 @@ -1611,28 +1641,28 @@ The `fortran` module shows the current compiler version of Fortran. ### Options -| Option | Default | Description | -| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `기호` | `' '` | The symbol used before displaying the version of Fortran. | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `기호` | `' '` | The symbol used before displaying the version of Fortran. | +| `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. | +| `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 | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | 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 +\*: This variable can only be used as a part of a style string ### Commands @@ -1646,28 +1676,29 @@ If a Fortran compiler is not supported by this module, you can request it by [ra 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| Option | Default | Description | +| ------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | -| `기호` | `' '` | The symbol used before the branch name of the check-out in your current directory. | -| `style` | `'bold purple'` | The style for the module. | -| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `기호` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | -| `disabled` | `true` | Disables the `fossil_branch` module. | +| `disabled` | `true` | Disables the `fossil_branch` module. | ### Variables -| | 예시 | Description | -| --------- | ------- | ------------------------------------ | -| branch | `trunk` | The active Fossil branch | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1684,12 +1715,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] 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 -| Option | Default | Description | -| -------------------- | ------------------------------------------------------------ | ------------------------------------- | +| Option | Default | Description | +| -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `added_style` | `'bold green'` | The style for the added count. | | `deleted_style` | `'bold red'` | The style for the deleted count. | @@ -1698,14 +1730,14 @@ The `fossil_metrics` module will show the number of added and deleted lines in t ### Variables -| | 예시 | Description | -| ----------------- | --- | ------------------------------------------- | -| added | `1` | The current number of added lines | -| deleted | `2` | The current number of deleted lines | +| | 예시 | Description | +| ------------------------------------ | --- | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1719,35 +1751,37 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Google Cloud (`gcloud`) -The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. +This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. +The `CLOUDSDK_CORE_PROJECT` and `CLOUDSDK_COMPUTE_REGION` environment variables, when set, override the `project` and `region` values from the active configuration, mirroring the behavior of `gcloud` itself. When the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active when one of the environment variables has been set. ### Options -| Option | Default | Description | -| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | +| Option | Default | Description | +| ----------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | The format for the module. | | `기호` | `'☁️ '` | 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. | -| `detect_env_vars` | `[]` | Which environmental variables should trigger this module | +| `detect_env_vars` | `[]` | Which environmental variables should trigger this module | | `style` | `'bold blue'` | The style for the module. | | `disabled` | `false` | Disables the `gcloud` module. | ### Variables -| | 예시 | Description | -| --------- | ------------- | ------------------------------------------------------------------ | -| region | `us-central1` | The current GCP region | -| account | `foo` | The current GCP profile | -| domain | `example.com` | The current GCP profile domain | -| project | | The current GCP project | -| active | `default` | The active config name written in `~/.config/gcloud/active_config` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1799,30 +1833,30 @@ The `git_branch` module shows the active branch of the repo in your current dire ### Options -| Option | Default | Description | -| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| Option | Default | Description | +| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | -| `기호` | `' '` | A format string representing the symbol of git branch. | -| `style` | `'bold purple'` | The style for the module. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `기호` | `' '` | A format string representing the symbol of git branch. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `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. | +| `ignore_bare_repo` | `false` | Do not show when in a bare repo. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables -| | 예시 | Description | -| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | -| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | -| remote_name | `origin` | The remote name. | -| remote_branch | `master` | The name of the branch tracked on `remote_name`. | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| | 예시 | Description | +| ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1842,26 +1876,26 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Options -| Option | Default | Description | -| -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash$tag\)]($style) '` | The format for the module. | -| `style` | `'bold green'` | The style for the module. | -| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | -| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| Option | Default | Description | +| -------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `'[\($hash$tag\)]($style) '` | The format for the module. | +| `style` | `'bold green'` | The style for the module. | +| `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. | +| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | -------------------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| tag | `v1.0.0` | The tag name if showing tag info is enabled. | -| style\* | | Mirrors the value of option `style` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------------------------------ | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1879,29 +1913,29 @@ The `git_state` module will show in directories which are part of a git reposito ### Options -| Option | Default | Description | -| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | -| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | -| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | -| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | -| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | -| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | -| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | -| `style` | `'bold yellow'` | The style for the module. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. | -| `disabled` | `false` | Disables the `git_state` module. | +| Option | Default | Description | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `'bold yellow'` | The style for the module. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables -| | 예시 | Description | -| ---------------- | ---------- | ----------------------------------- | -| state | `REBASING` | The current state of the repo | +| | 예시 | 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` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1917,29 +1951,30 @@ 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 -| Option | Default | Description | -| -------------------- | ------------------------------------------------------------ | ------------------------------------- | +| Option | Default | Description | +| -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | | `added_style` | `'bold green'` | The style for the added count. | | `deleted_style` | `'bold red'` | The style for the deleted count. | | `only_nonzero_diffs` | `true` | Render status only for changed items. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `disabled` | `true` | Disables the `git_metrics` module. | -| `ignore_submodules` | `false` | Ignore changes to submodules | +| `ignore_submodules` | `false` | Ignore changes to submodules | ### Variables -| | 예시 | Description | -| ----------------- | --- | ------------------------------------------- | -| added | `1` | The current number of added lines | -| deleted | `2` | The current number of deleted lines | +| | 예시 | Description | +| ------------------------------------ | --- | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -1955,45 +1990,46 @@ 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 -| Option | Default | Description | -| ---------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | -| `conflicted` | `'='` | The format shown when this branch has merge conflicts. | -| `ahead` | `'⇡'` | The format shown when this branch is ahead of the branch being tracked. | -| `behind` | `'⇣'` | The format shown when this branch is behind the branch being tracked. | -| `diverged` | `'⇕'` | The format shown when this branch has diverged from the branch being tracked. | -| `up_to_date` | `''` | The format shown when this branch is up to date with the branch being tracked. | -| `untracked` | `'?'` | The format shown when there are untracked files in the working directory. | -| `stashed` | `'\$'` | The format shown when a stash exists for the local repository. | -| `modified` | `'!'` | The format shown when there are file modifications in the working directory. | -| `staged` | `'+'` | The format shown when a new file has been added to the staging area. | -| `renamed` | `'»'` | The format shown when a renamed file has been added to the staging area. | -| `deleted` | `'✘'` | The format shown when a file's deletion has been added to the staging area. | -| `typechanged` | `""` | The format shown when a file's type has been changed in the staging area. | -| `style` | `'bold red'` | The style for the module. | -| `ignore_submodules` | `false` | Ignore changes to submodules. | -| `worktree_added` | `""` | The format shown when a new file has been added in the working directory. | -| `worktree_deleted` | `""` | The format shown when a file has been deleted in the working directory. | -| `worktree_modified` | `""` | The format shown when a file has been modified in the working directory. | -| `worktree_typechanged` | `""` | The format shown when a file's type has been changed in the working directory. | -| `index_added` | `""` | The format shown when a new file has been added to the staging area. | -| `index_deleted` | `""` | The format shown when a file has been deleted from the staging area. | -| `index_modified` | `""` | The format shown when a file has been modified in the staging area. | -| `index_typechanged` | `""` | The format shown when a file's type has been changed in the staging area. | -| `disabled` | `false` | Disables the `git_status` module. | +| Option | Default | Description | +| ---------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `'='` | The format shown when this branch has merge conflicts. | +| `ahead` | `'⇡'` | The format shown when this branch is ahead of the branch being tracked. | +| `behind` | `'⇣'` | The format shown when this branch is behind the branch being tracked. | +| `diverged` | `'⇕'` | The format shown when this branch has diverged from the branch being tracked. | +| `up_to_date` | `''` | The format shown when this branch is up to date with the branch being tracked. | +| `untracked` | `'?'` | The format shown when there are untracked files in the working directory. | +| `stashed` | `'\$'` | The format shown when a stash exists for the local repository. | +| `modified` | `'!'` | The format shown when there are file modifications in the working directory. | +| `staged` | `'+'` | The format shown when a new file has been added to the staging area. | +| `renamed` | `'»'` | The format shown when a renamed file has been added to the staging area. | +| `deleted` | `'✘'` | The format shown when a file's deletion has been added to the staging area. | +| `typechanged` | `""` | The format shown when a file's type has been changed in the staging area. | +| `style` | `'bold red'` | The style for the module. | +| `ignore_submodules` | `false` | Ignore changes to submodules. | +| `worktree_added` | `""` | The format shown when a new file has been added in the working directory. | +| `worktree_deleted` | `""` | The format shown when a file has been deleted in the working directory. | +| `worktree_modified` | `""` | The format shown when a file has been modified in the working directory. | +| `worktree_typechanged` | `""` | The format shown when a file's type has been changed in the working directory. | +| `index_added` | `""` | The format shown when a new file has been added to the staging area. | +| `index_deleted` | `""` | The format shown when a file has been deleted from the staging area. | +| `index_modified` | `""` | The format shown when a file has been modified in the staging area. | +| `index_typechanged` | `""` | The format shown when a file's type has been changed in the staging area. | +| `disabled` | `false` | Disables the `git_status` module. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | -| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. | +| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. | ### Variables The following variables can be used in `format`: -| | Description | -| ---------------------- | ------------------------------------------------------------------------------------------------------------- | +| | Description | +| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `all_status` | Shortcut for `$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. | @@ -2012,9 +2048,9 @@ The following variables can be used in `format`: | `index_deleted` | Displays `index_deleted` when a file has been deleted from the staging area. | | `index_modified` | Displays `index_modified` when a file has been modified in the staging area. | | `index_typechanged` | Displays `index_typechanged` when a file's type has been changed in the staging area. | -| style\* | Mirrors the value of option `style` | +| style\* | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string The following variables can be used in `diverged`: @@ -2070,32 +2106,33 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e ## Gleam -The `gleam` module shows the currently installed version of [Gleam](https://gleam.run/). By default the module will be shown if any of the following conditions are met: +The `gleam` module shows the currently installed version of [Gleam](https://gleam.run/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `gleam.toml` file - The current directory contains a file with the `.gleam` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'⭐ '` | 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. | -| `style` | `'bold #FFAFF3'` | The style for the module. | -| `disabled` | `false` | Disables the `gleam` module. | +| `기호` | `'⭐ '` | 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. | +| `style` | `'bold #FFAFF3'` | The style for the module. | +| `disabled` | `false` | Disables the `gleam` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v1.0.0` | The version of `gleam` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v1.0.0` | The version of `gleam` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2108,7 +2145,8 @@ format = 'via [⭐ $version](bold red) ' ## Go -The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met: +The `golang` module shows the currently installed version of [Go](https://golang.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `go.mod` file - The current directory contains a `go.sum` file @@ -2122,28 +2160,28 @@ The `golang` module shows the currently installed version of [Go](https://golang ### 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` | -| `기호` | `'🐹 '` | 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. | -| `style` | `'bold cyan'` | The style for the module. | +| 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` | +| `기호` | `'🐹 '` | 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. | +| `style` | `'bold cyan'` | The style for the module. | | `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` | Disables the `golang` module. | +| `disabled` | `false` | Disables the `golang` module. | ### Variables -| | 예시 | Description | -| ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| version | `v1.12.1` | The version of `go` | +| | 예시 | Description | +| -------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| version | `v1.12.1` | The version of `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. | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2165,25 +2203,26 @@ format = 'via [$symbol($version )($mod_version )]($style)' ## Guix-shell -The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. +The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. +The module will be shown when inside a guix-shell environment. ### Options -| Option | Default | Description | -| ---------- | -------------------------- | ------------------------------------------------------ | +| Option | Default | Description | +| ---------- | -------------------------- | ---------------------------------------------------------------------- | | `format` | `'via [$symbol]($style) '` | The format for the module. | -| `기호` | `'🐃 '` | A format string representing the symbol of guix-shell. | +| `기호` | `'🐃 '` | A format string representing the symbol of guix-shell. | | `style` | `'yellow bold'` | The style for the module. | | `disabled` | `false` | Disables the `guix_shell` module. | ### Variables -| | 예시 | Description | -| --------- | -- | ------------------------------------ | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -- | ------------------------------------ | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2208,17 +2247,17 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🅶 '` | A format string representing the symbol of Gradle. | -| `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `['gradle']` | Which folders should trigger this module. | -| `style` | `'bold bright-cyan'` | The style for the module. | -| `disabled` | `false` | Disables the `gradle` module. | -| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | +| `기호` | `'🅶 '` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `['gradle']` | Which folders should trigger this module. | +| `style` | `'bold bright-cyan'` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | ### Variables @@ -2226,9 +2265,9 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c | ------- | -------- | ------------------------------------ | | version | `v7.5.1` | The version of `gradle` | | 기호 | | Mirrors the value of option `symbol` | -| style* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## Haskell @@ -2241,31 +2280,32 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | -------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `기호` | `'λ '` | A format string representing the symbol of Haskell | -| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Which extensions should trigger this module. | -| `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `'bold purple'` | The style for the module. | -| `disabled` | `false` | Disables the `haskell` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `기호` | `'λ '` | A format string representing the symbol of Haskell | +| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Which extensions should trigger this module. | +| `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `'bold purple'` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | ### Variables -| | 예시 | Description | -| -------------- | ----------- | --------------------------------------------------------------------------------------- | -| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | -| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| | 예시 | Description | +| ---------------------------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | | ghc\_version | `9.2.1` | Currently installed GHC version | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## Haxe -The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/). By default the module will be shown if any of the following conditions are met: +The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file - The current directory contains a `.haxelib` or a `haxe_libraries` directory @@ -2273,26 +2313,26 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o ### Options -| Option | Default | Description | -| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `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 module. | -| `기호` | `'⌘ '` | A format string representing the symbol of Haxe. | -| `style` | `'bold fg:202'` | The style for the module. | -| `disabled` | `false` | Disables the `haxe` module. | +| `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 module. | +| `기호` | `'⌘ '` | A format string representing the symbol of Haxe. | +| `style` | `'bold fg:202'` | The style for the module. | +| `disabled` | `false` | Disables the `haxe` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v4.2.5` | The version of `haxe` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v4.2.5` | The version of `haxe` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2305,33 +2345,34 @@ format = "via [⌘ $version](bold fg:202) " ## Helm -The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `helmfile.yaml` file - The current directory contains a `Chart.yaml` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `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 module. | -| `기호` | `'⎈ '` | A format string representing the symbol of Helm. | -| `style` | `'bold white'` | The style for the module. | -| `disabled` | `false` | Disables the `helm` module. | +| `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 module. | +| `기호` | `'⎈ '` | A format string representing the symbol of Helm. | +| `style` | `'bold white'` | The style for the module. | +| `disabled` | `false` | Disables the `helm` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v3.1.1` | The version of `helm` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v3.1.1` | The version of `helm` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2348,26 +2389,26 @@ The `hostname` module shows the system hostname. ### Options -| Option | Default | Description | -| ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | -| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| Option | Default | Description | +| ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation. | -| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. | -| `style` | `'bold dimmed green'` | The style for the module. | -| `disabled` | `false` | Disables the `hostname` module. | -| `aliases` | `{}` | Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. | +| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. | +| `style` | `'bold dimmed green'` | The style for the module. | +| `disabled` | `false` | Disables the `hostname` module. | +| `aliases` | `{}` | Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. | ### Variables -| | 예시 | Description | -| ---------- | ---------- | ----------------------------------------------------- | -| 호스트 이름 | `computer` | The hostname of the computer | -| style\* | | Mirrors the value of option `style` | -| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | +| | 예시 | Description | +| ------------------------------- | ---------- | ----------------------------------------------------- | +| 호스트 이름 | `computer` | The hostname of the computer | +| style\* | | Mirrors the value of option `style` | +| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2404,33 +2445,34 @@ aliases = { "Max's MacBook Pro" = "home" } ## Java -The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension ### Options -| Option | Default | Description | -| ------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. | +| 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` | -| `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 module. | -| `기호` | `'☕ '` | A format string representing the symbol of Java | -| `style` | `'red dimmed'` | The style for the module. | -| `disabled` | `false` | Disables the `java` module. | +| `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 module. | +| `기호` | `'☕ '` | A format string representing the symbol of Java | +| `style` | `'red dimmed'` | The style for the module. | +| `disabled` | `false` | Disables the `java` module. | ### Variables -| | 예시 | Description | -| --------- | ----- | ------------------------------------ | -| version | `v14` | The version of `java` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ----- | ------------------------------------ | +| version | `v14` | The version of `java` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2443,7 +2485,10 @@ symbol = '🌟 ' ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. +The module will be shown only if there are background jobs running. +The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. +The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -2457,9 +2502,9 @@ The default functionality is: ### Options -| Option | Default | Description | -| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | Show number of jobs if exceeded. | +| Option | Default | Description | +| ------------------ | ----------------------------- | ---------------------------------------------------------------------------------------- | +| `threshold`\* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `'[$symbol$number]($style) '` | The format for the module. | @@ -2467,17 +2512,17 @@ The default functionality is: | `style` | `'bold blue'` | The style for the module. | | `disabled` | `false` | Disables the `jobs` module. | -*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. +\*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variables -| | 예시 | Description | -| --------- | --- | ------------------------------------ | -| number | `1` | The number of jobs | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --- | ------------------------------------ | +| number | `1` | The number of jobs | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2500,7 +2545,8 @@ 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: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `Project.toml` file - The current directory contains a `Manifest.toml` file @@ -2508,26 +2554,26 @@ The `julia` module shows the currently installed version of [Julia](https://juli ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `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 module. | -| `기호` | `'ஃ '` | A format string representing the symbol of Julia. | -| `style` | `'bold purple'` | The style for the module. | -| `disabled` | `false` | Disables the `julia` module. | +| `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 module. | +| `기호` | `'ஃ '` | A format string representing the symbol of Julia. | +| `style` | `'bold purple'` | The style for the module. | +| `disabled` | `false` | Disables the `julia` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v1.4.0` | The version of `julia` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v1.4.0` | The version of `julia` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2540,33 +2586,34 @@ symbol = '∴ ' ## Kotlin -The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `.kt` or a `.kts` file ### 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` | -| `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 module. | -| `기호` | `'🅺 '` | A format string representing the symbol of Kotlin. | -| `style` | `'bold blue'` | The style for the module. | -| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `kotlin` module. | +| 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` | +| `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 module. | +| `기호` | `'🅺 '` | A format string representing the symbol of Kotlin. | +| `style` | `'bold blue'` | The style for the module. | +| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| version | `v1.4.21` | The version of `kotlin` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| version | `v1.4.21` | The version of `kotlin` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2587,40 +2634,44 @@ kotlin_binary = 'kotlinc' ## Kubernetes -Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. +The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. +Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. +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. -> +> [!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. -| Option | Default | Description | -| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| Option | Default | Description | +| ------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------- | | `기호` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `style` | `'cyan bold'` | The style for the module. | -| `context_aliases`* | `{}` | Table of context aliases to display. | -| `user_aliases`* | `{}` | Table of user aliases to display. | +| `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 module. | -| `detect_env_vars` | `[]` | Which environmental variables should trigger this module | +| `detect_env_vars` | `[]` | Which environmental variables should trigger this module | | `contexts` | `[]` | Customized styles and symbols for specific contexts. | | `disabled` | `true` | Disables the `kubernetes` module. | -*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead. +\*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead. To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list: -| | Description | -| ----------------- | ---------------------------------------------------------------------------------------- | -| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. | -| `user_pattern` | Regular expression to match current Kubernetes user name. | -| `context_alias` | Context alias to display instead of the full context name. | -| `user_alias` | User alias to display instead of the full user name. | +| | Description | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------ | +| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. | +| `user_pattern` | Regular expression to match current Kubernetes user name. | +| `context_alias` | Context alias to display instead of the full context name. | +| `user_alias` | User alias to display instead of the full user name. | | `style` | The style for the module when using this context. If not set, will use module's style. | | `기호` | The symbol for the module when using this context. If not set, will use module's symbol. | @@ -2635,9 +2686,9 @@ Note that all regular expression are anchored with `^$` and so must mat | user | `starship-user` | If set, the current kubernetes user | | cluster | `starship-cluster` | If set, the current kubernetes cluster | | 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2700,8 +2751,8 @@ The `line_break` module separates the prompt into two lines. ### Options -| Option | Default | Description | -| ---------- | ------- | ------------------------------------------------------------------ | +| Option | Default | Description | +| ---------- | ------- | ---------------------------------------------------------------------------------- | | `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### 예시 @@ -2717,12 +2768,13 @@ 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ---------- | ------------------------- | ------------------------------------------------------ | +| Option | Default | Description | +| ---------- | ------------------------- | ---------------------------------------------------------------------- | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `format` | `'[$localipv4]($style) '` | The format for the module. | | `style` | `'bold yellow'` | The style for the module. | @@ -2730,12 +2782,12 @@ The `localip` module shows the IPv4 address of the primary network interface. ### Variables -| | 예시 | Description | -| --------- | ------------ | ----------------------------------- | +| | 예시 | Description | +| --------- | ------------------------------------------------------------ | ----------------------------------- | | localipv4 | 192.168.1.13 | Contains the primary IPv4 address | -| style\* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2750,7 +2802,8 @@ disabled = false ## Lua -The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `.lua-version` file - The current directory contains a `lua` directory @@ -2758,27 +2811,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o ### 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` | -| `기호` | `'🌙 '` | 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. | -| `style` | `'bold blue'` | The style for the module. | -| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `lua` module. | +| 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` | +| `기호` | `'🌙 '` | 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. | +| `style` | `'bold blue'` | The style for the module. | +| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v5.4.0` | The version of `lua` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v5.4.0` | The version of `lua` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2802,17 +2855,17 @@ If you use an alternate POM syntax (for example `pom.hocon`), add its filename t ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🅼 '` | A format string representing the symbol of Maven. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `['pom.xml']` | Which filenames should trigger this module. | -| `detect_folders` | `['.mvn']` | Which folders should trigger this module. | -| `style` | `'bold bright-cyan'` | The style for the module. | -| `disabled` | `false` | Disables the `maven` module. | -| `recursive` | `false` | Enables recursive finding for the `.mvn` directory. | +| `기호` | `'🅼 '` | A format string representing the symbol of Maven. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `['pom.xml']` | Which filenames should trigger this module. | +| `detect_folders` | `['.mvn']` | Which folders should trigger this module. | +| `style` | `'bold bright-cyan'` | The style for the module. | +| `disabled` | `false` | Disables the `maven` module. | +| `recursive` | `false` | Enables recursive finding for the `.mvn` directory. | ### Variables @@ -2820,9 +2873,9 @@ If you use an alternate POM syntax (for example `pom.hocon`), add its filename t | ------- | -------- | ------------------------------------ | | version | `v3.2.0` | The version of `maven` | | 기호 | | Mirrors the value of option `symbol` | -| style* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## Memory Usage @@ -2830,30 +2883,31 @@ 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 -| Option | Default | Description | -| ----------- | ----------------------------------------------- | -------------------------------------------------------- | -| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| Option | Default | Description | +| ----------- | ---------------------------------------------- | ------------------------------------------------------------------------ | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | | `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | The format for the module. | -| `기호` | `'🐏'` | The symbol used before displaying the memory usage. | -| `style` | `'bold dimmed white'` | The style for the module. | -| `disabled` | `true` | Disables the `memory_usage` module. | +| `기호` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | The style for the module. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables -| | 예시 | Description | -| ---------------- | ------------- | ------------------------------------------------------------------ | -| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | -| ram_pct | `48%` | The percentage of the current system memory. | -| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| | 예시 | Description | +| --------------------------------- | ------------- | ---------------------------------------------------------------------------------- | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | | swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | -| 기호 | `🐏` | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 기호 | `🐏` | 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 *\*: The SWAP file information is only displayed if detected on the current system +\*: 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 ### 예시 @@ -2875,24 +2929,24 @@ By default the Meson project name is displayed, if `$MESON_DEVENV` is set. ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- | -| `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. | +| Option | Default | Description | +| ------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `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. | -| `기호` | `'⬢ '` | The symbol used before displaying the project name. | -| `style` | `'blue bold'` | The style for the module. | -| `disabled` | `false` | Disables the `meson` module. | +| `format` | `'via [$symbol$project]($style) '` | The format for the module. | +| `기호` | `'⬢ '` | The symbol used before displaying the project name. | +| `style` | `'blue bold'` | The style for the module. | +| `disabled` | `false` | Disables the `meson` module. | ### Variables -| | 예시 | Description | -| --------- | ---------- | ------------------------------------ | -| project | `starship` | The current Meson project name | -| 기호 | `🐏` | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ---------- | ------------------------------------ | +| project | `starship` | The current Meson project name | +| 기호 | `🐏` | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2910,29 +2964,30 @@ 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | `기호` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `style` | `'bold purple'` | The style for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | | `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| topic | `feature` | The active mercurial topic | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -2949,12 +3004,13 @@ truncation_symbol = '' 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ------------ | --------------------------- | ------------------------------------------------------------- | +| 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. | @@ -2969,25 +3025,26 @@ The `hg_state` module will show in directories which are part of a mercurial rep ### Variables -| | 예시 | Description | -| ---------------- | ---------- | ----------------------------------- | -| state | `REBASING` | The current state of the repo | +| | 예시 | 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` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------ | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------- | | `기호` | `'mise '` | The symbol used before displaying _mise_ health. | | `style` | `'bold purple'` | The style for the module. | | `format` | `'on [$symbol$health]($style) '` | The format for the module. | @@ -3000,13 +3057,13 @@ The `mise` module shows the current mise health as reported by running `mise doc ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| health | `healthy` | The health of _mise_ | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| health | `healthy` | The health of _mise_ | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3023,25 +3080,25 @@ The `mojo` module shows the current version of [Mojo programming language](https ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------- | ------------------------------------------------------ | +| Option | Default | Description | +| ------------------- | ------------------------------------- | ---------------------------------------------------------------------- | | `format` | `'with [$symbol($version )]($style)'` | The format for the module. | -| `기호` | `'🔥 '` | The symbol used before displaying the version of Mojo. | +| `기호` | `'🔥 '` | The symbol used before displaying the version of Mojo. | | `style` | `'bold 208'` | The style for the module. | | `disabled` | `false` | Disables the `mojo` module. | -| `detect_extensions` | `['mojo', '🔥']` | Which extensions should trigger this 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. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `24.4.0` | The version of `mojo` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `24.4.0` | The version of `mojo` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3058,19 +3115,19 @@ The `nats` module shows the name of the current [NATS](https://nats.io) context. ### Options -| Option | Default | Description | -| ---------- | -------------------------- | ------------------------------------------------------------ | +| Option | Default | Description | +| ---------- | -------------------------- | ----------------------------------------------------------------------------------------------- | | `기호` | `'✉️ '` | The symbol used before the NATS context (defaults to empty). | -| `style` | `'bold purple'` | The style for the module. | -| `format` | `'[$symbol$name]($style)'` | The format for the module. | -| `disabled` | `false` | Disables the `nats` module. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'[$symbol$name]($style)'` | The format for the module. | +| `disabled` | `false` | Disables the `nats` module. | ### Variables -| | 예시 | Description | -| --------- | ----------- | ------------------------------------ | -| name | `localhost` | The name of the NATS context | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ----------- | ------------------------------------ | +| name | `localhost` | The name of the NATS context | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | ### 예시 @@ -3083,23 +3140,24 @@ style = 'bold purple' ## Network Namespace -The `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected. +The `netns` module shows the current network namespace. +This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected. ### Options -| Option | Default | Description | -| ---------- | --------------------------------- | ----------------------------------------------------------------- | -| `format` | `'[$symbol \[$name\]]($style)'` | The format for the module. | -| `기호` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). | -| `style` | `'blue bold dimmed'` | The style for the module. | -| `disabled` | `false` | Disables the `netns` module. | +| Option | Default | Description | +| ---------- | --------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `format` | `'[$symbol \[$name\]]($style)'` | The format for the module. | +| `기호` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). | +| `style` | `'blue bold dimmed'` | The style for the module. | +| `disabled` | `false` | Disables the `netns` module. | ### Variables -| | 예시 | Description | -| --------- | ---------- | ----------------------------------------- | -| name | `my-netns` | The name of the current network namespace | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ---------- | ----------------------------------------- | +| name | `my-netns` | The name of the current network namespace | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | ### 예시 @@ -3114,7 +3172,8 @@ symbol = '🌐 ' ## Nim -The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension @@ -3123,26 +3182,26 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module | +| 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 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. | -| `style` | `'bold yellow'` | The style for the module. | -| `disabled` | `false` | Disables the `nim` module. | +| `기호` | `'👑 '` | 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. | +| `style` | `'bold yellow'` | The style for the module. | +| `disabled` | `false` | Disables the `nim` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v1.2.0` | The version of `nimc` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v1.2.0` | The version of `nimc` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3156,12 +3215,13 @@ symbol = '🎣 ' ## Nix-shell -The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. +The module will be shown when inside a nix-shell environment. ### Options -| Option | Default | Description | -| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------- | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `기호` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `style` | `'bold blue'` | The style for the module. | @@ -3173,14 +3233,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Variables -| | 예시 | Description | -| --------- | ------- | ------------------------------------ | -| state | `pure` | The state of the nix-shell | -| name | `lorri` | The name of the nix-shell | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| | 예시 | Description | +| ------- | ------- | ------------------------------------------------------------------------------------------------ | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | +| level | `1` | The depth level of the nix-shell (Only when using [Lix](https://lix.systems)) | +| `기호` | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3197,7 +3258,8 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `package.json` file - The current directory contains a `.node-version` file @@ -3210,28 +3272,28 @@ Additionally, the module will be hidden by default if the directory contains a ` ### 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` | -| `기호` | `' '` | 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. | -| `style` | `'bold green'` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | +| 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` | +| `기호` | `' '` | 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. | +| `style` | `'bold green'` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | | `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables -| | 예시 | Description | -| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| version | `v13.12.0` | The version of `node` | +| | 예시 | Description | +| ------------------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| version | `v13.12.0` | The version of `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. | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3244,7 +3306,8 @@ format = 'via [🤖 $version](bold green) ' ## OCaml -The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -3255,30 +3318,30 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam ### Options -| Option | Default | Description | -| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string for the module. | +| Option | Default | Description | +| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'🐫 '` | 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. | -| `style` | `'bold yellow'` | The style for the module. | -| `disabled` | `false` | Disables the `ocaml` module. | +| `기호` | `'🐫 '` | 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. | +| `style` | `'bold yellow'` | The style for the module. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variables -| | 예시 | Description | -| ---------------- | ------------ | ----------------------------------------------------------------- | -| version | `v4.10.0` | The version of `ocaml` | +| | 예시 | Description | +| ------------------------------------- | ------------ | ----------------------------------------------------------------- | +| version | `v4.10.0` | The version of `ocaml` | | switch_name | `my-project` | The active OPAM switch | | switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3295,8 +3358,8 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| 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. | @@ -3308,13 +3371,13 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l ### Variables -| | 예시 | Description | -| --------- | ------------- | ------------------------------------ | -| version | `dev-2024-03` | The version of `odin` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------------- | ------------------------------------ | +| version | `dev-2024-03` | The version of `odin` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3328,30 +3391,31 @@ show_commit = true ## Open Policy Agent -The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file. +The `opa` module shows the currently installed version of the OPA tool. +By default the module will be shown if the current directory contains a `.rego` file. ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🪖 '` | 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. | -| `style` | `'bold blue'` | The style for the module. | -| `disabled` | `false` | Disables the `opa` module. | +| `기호` | `'🪖 '` | 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. | +| `style` | `'bold blue'` | The style for the module. | +| `disabled` | `false` | Disables the `opa` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| version | `v0.44.0` | The version of `opa` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| version | `v0.44.0` | The version of `opa` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3364,12 +3428,13 @@ format = 'via [⛑️ $version](bold red) ' ## OpenStack -The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). +to fetch the current project in use. ### Options -| Option | Default | Description | -| ---------- | ----------------------------------------------- | -------------------------------------------------------------- | +| Option | Default | Description | +| ---------- | ----------------------------------------------- | ------------------------------------------------------------------------------ | | `format` | `'on [$symbol$cloud(\($project\))]($style) '` | The format for the module. | | `기호` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. | | `style` | `'bold yellow'` | The style for the module. | @@ -3377,14 +3442,14 @@ The `openstack` module shows the current OpenStack cloud and project. The module ### Variables -| | 예시 | Description | -| --------- | ------ | ------------------------------------ | -| cloud | `corp` | The current OpenStack cloud | -| project | `dev` | The current OpenStack project | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------ | ------------------------------------ | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3399,22 +3464,27 @@ symbol = '☁️ ' ## OS -The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. +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. -> [!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 -| Option | Default | Description | -| ---------- | --------------------- | ------------------------------------------------------ | +| Option | Default | Description | +| ---------- | --------------------- | ---------------------------------------------------------------------- | | `format` | `'[$symbol]($style)'` | The format for the module. | | `style` | `'bold white'` | The style for the module. | | `disabled` | `true` | Disables the `os` module. | | `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). +`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). ```toml # This is the default symbols table. @@ -3481,17 +3551,17 @@ Zorin = "🔹 " ### Variables -| | 예시 | Description | -| --------- | ------------ | ------------------------------------------------------------------ | -| 기호 | `🎗️` | The current operating system symbol from advanced option `symbols` | -| name | `Arch Linux` | The current operating system name | -| 종류 | `Arch` | The current operating system type | -| 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` | +| | 예시 | Description | +| -------- | ------------ | ------------------------------------------------------------------ | +| 기호 | `🎗️` | The current operating system symbol from advanced option `symbols` | +| name | `Arch Linux` | The current operating system name | +| 종류 | `Arch` | The current operating system type | +| 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` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3536,24 +3606,24 @@ The `package` module is shown when the current directory is the repository for a ### Options -| Option | Default | Description | -| ----------------- | --------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'is [$symbol$version]($style) '` | The format for the module. | -| `기호` | `'📦 '` | The symbol used before displaying the version the package. | +| Option | Default | Description | +| ----------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'is [$symbol$version]($style) '` | The format for the module. | +| `기호` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `style` | `'bold 208'` | The style for the module. | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| `style` | `'bold 208'` | The style for the module. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v1.0.0` | The version of your package | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v1.0.0` | The version of your package | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3566,7 +3636,8 @@ format = 'via [🎁 $version](208 bold) ' ## Perl -The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -3576,23 +3647,23 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'🐪 '` | 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. | -| `style` | `'bold 149'` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| `기호` | `'🐪 '` | 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. | +| `style` | `'bold 149'` | The style for the module. | +| `disabled` | `false` | Disables the `perl` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| version | `v5.26.1` | The version of `perl` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| version | `v5.26.1` | The version of `perl` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | ### 예시 @@ -3606,7 +3677,8 @@ format = 'via [🦪 $version]($style) ' ## PHP -The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -3614,26 +3686,26 @@ The `php` module shows the currently installed version of [PHP](https://www.php. ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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 displaying the version of PHP. | -| `detect_extensions` | `['php']` | Which extensions should trigger this module. | -| `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `'147 bold'` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| `기호` | `'🐘 '` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `['php']` | Which extensions should trigger this module. | +| `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `'147 bold'` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v7.3.8` | The version of `php` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v7.3.8` | The version of `php` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3648,16 +3720,17 @@ 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| Option | Default | Description | +| ------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------- | | `기호` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | | `style` | `'bold purple'` | The style for the module. | | `format` | `'on [$symbol$channel]($style) '` | The format for the module. | -| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | | `disabled` | `true` | Disables the `pijul` module. | @@ -3669,27 +3742,28 @@ The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as ### Options -| Option | Default | Description | -| -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `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. | -| `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` | `[]` | Which folders should trigger this module. | -| `disabled` | `false` | Disables the `pixi` module. | +| Option | Default | Description | +| -------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| `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. | +| `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` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `pixi` module. | ### Variables -| | 예시 | Description | -| ----------- | --------- | ------------------------------------ | -| version | `v0.33.0` | The version of `pixi` | -| environment | `py311` | The current pixi environment | -| 기호 | | Mirrors the value of option `symbol` | -| style | | Mirrors the value of option `style` | +| | 예시 | Description | +| --------------------------------- | ------------ | ------------------------------------ | +| version | `v0.33.0` | The version of `pixi` | +| environment | `py311` | The current pixi environment | +| project_name | `my-project` | The current pixi project name | +| 기호 | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | ### 예시 @@ -3704,7 +3778,8 @@ 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: @@ -3713,26 +3788,26 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. | +| Option | Default | Description | +| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `' '` | A format string shown before the Pulumi stack. | -| `style` | `'bold 5'` | The style for the module. | -| `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. | -| `disabled` | `false` | Disables the `pulumi` module. | +| `기호` | `' '` | A format string shown before the Pulumi stack. | +| `style` | `'bold 5'` | The style for the module. | +| `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. | +| `disabled` | `false` | Disables the `pulumi` module. | ### Variables -| | 예시 | Description | -| --------- | ---------- | ------------------------------------ | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | -| username | `alice` | The current Pulumi username | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| | 예시 | Description | +| -------- | ---------- | ------------------------------------ | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3756,7 +3831,8 @@ format = '[$symbol$stack]($style) ' ## PureScript -The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. +By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a `spago.yaml` file @@ -3765,26 +3841,26 @@ The `purescript` module shows the currently installed version of [PureScript](ht ### Options -| Option | Default | Description | -| ------------------- | --------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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 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. | -| `style` | `'bold white'` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| `기호` | `'<=> '` | 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. | +| `style` | `'bold white'` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `0.13.5` | The version of `purescript` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `0.13.5` | The version of `purescript` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -3816,34 +3892,42 @@ By default, the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'🐍 '` | A format string representing the symbol of Python | -| `style` | `'yellow bold'` | The style for the module. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | -| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used | -| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should 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 | -| `generic_venv_names` | `[]` | Which venv names should be replaced with the parent directory name. | -| `disabled` | `false` | Disables the `python` module. | +| Option | Default | Description | +| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `기호` | `'🐍 '` | A format string representing the symbol of Python | +| `style` | `'yellow bold'` | The style for the module. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used | +| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should 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 | +| `generic_venv_names` | `[]` | Which venv names should be replaced with the parent directory name. | +| `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. -> +> [!TIP] The `python_binary` variable accepts either a string or a list of strings. +> +> - a string (e.g. `'python3'`), +> - a list of strings (e.g. `['python', 'python3']`) +> - a list of lists of strings, representing commands with optional arguments (e.g. +> `[['mise', 'exec', '--', 'python'], ['python3']]`) +> +> 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 -| | 예시 | Description | -| ------------ | --------------- | --------------------------------------------------------------------------- | -| version | `'v3.8.1'` | The version of `python` | -| 기호 | `'🐍 '` | Mirrors the value of option `symbol` | -| style | `'yellow bold'` | Mirrors the value of option `style` | +| | 예시 | Description | +| --------------------------------- | --------------- | --------------------------------------------------------------------------- | +| version | `'v3.8.1'` | The version of `python` | +| 기호 | `'🐍 '` | Mirrors the value of option `symbol` | +| style | `'yellow bold'` | Mirrors the value of option `style` | | pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` | -| virtualenv | `'venv'` | The current `virtualenv` name or the parent if matches `generic_venv_names` | +| virtualenv | `'venv'` | The current `virtualenv` name or the parent if matches `generic_venv_names` | ### 예시 @@ -3866,6 +3950,22 @@ python_binary = 'python3' ```toml # ~/.config/starship.toml +[python] +# Use `mise` to get the version. +python_binary = [['mise', 'exec', '--', 'python']] +``` + +```toml +# ~/.config/starship.toml + +[python] +# Potentially dangerous: `uv` can run any binary at `.venv/bin/python` without interaction +python_binary = [['uv', 'run', '--no-python-downloads', '--no-project', 'python']] +``` + +```toml +# ~/.config/starship.toml + [python] # Don't trigger for files with the py extension detect_extensions = [] @@ -3882,26 +3982,26 @@ By default, the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'⨁ '` | A format string representing the symbol of Quarto | -| `style` | `'bold #75AADB'` | The style for the module. | -| `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. | -| `disabled` | `false` | Disables the `quarto` module. | +| `기호` | `'⨁ '` | A format string representing the symbol of Quarto | +| `style` | `'bold #75AADB'` | The style for the module. | +| `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. | +| `disabled` | `false` | Disables the `quarto` module. | ### Variables -| | 예시 | Description | -| --------- | --------- | ------------------------------------ | -| version | `1.4.549` | The version of `quarto` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --------- | ------------------------------------ | +| version | `1.4.549` | The version of `quarto` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## R @@ -3917,16 +4017,16 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'📐'` | A format string representing the symbol of R. | -| `style` | `'blue bold'` | The style for the module. | -| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Which extensions should trigger this module | -| `detect_files` | `['.Rprofile']` | Which filenames should trigger this module | -| `detect_folders` | `['.Rproj.user']` | Which folders should trigger this module | -| `disabled` | `false` | Disables the `r` module. | +| `기호` | `'📐'` | A format string representing the symbol of R. | +| `style` | `'blue bold'` | The style for the module. | +| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Which extensions should trigger this module | +| `detect_files` | `['.Rprofile']` | Which filenames should trigger this module | +| `detect_folders` | `['.Rproj.user']` | Which folders should trigger this module | +| `disabled` | `false` | Disables the `r` module. | ### Variables @@ -3947,32 +4047,33 @@ format = 'with [📐 $version](blue bold) ' ## Raku -The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met: +The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `META6.json` file - The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6` ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'🦋 '` | 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. | -| `style` | `'bold 149'` | The style for the module. | -| `disabled` | `false` | Disables the `raku` module. | +| 기호 | `'🦋 '` | 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. | +| `style` | `'bold 149'` | The style for the module. | +| `disabled` | `false` | Disables the `raku` module. | ### Variables -| | 예시 | Description | -| ---------- | ------ | ------------------------------------ | -| version | `v6.d` | The version of `raku` | +| | 예시 | Description | +| ------------------------------- | ------ | ------------------------------------ | +| version | `v6.d` | The version of `raku` | | vm_version | `moar` | The version of VM `raku` is built on | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | ### 예시 @@ -3985,32 +4086,33 @@ format = 'via [🦪 $version]($style) ' ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). +The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🔺 '` | 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. | -| `style` | `'red bold'` | The style for the module. | -| `disabled` | `false` | Disables the `red` module. | +| `기호` | `'🔺 '` | 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. | +| `style` | `'red bold'` | The style for the module. | +| `disabled` | `false` | Disables the `red` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v2.5.1` | The version of `red` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v2.5.1` | The version of `red` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4023,7 +4125,8 @@ symbol = '🔴 ' ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). +The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -4034,28 +4137,28 @@ Starship gets the current Ruby version by running `ruby -v`. ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'💎 '` | 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_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | -| `style` | `'bold red'` | The style for the module. | -| `disabled` | `false` | Disables the `ruby` module. | +| `기호` | `'💎 '` | 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_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | +| `style` | `'bold red'` | The style for the module. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------------- | -| version | `v2.5.1` | The version of `ruby` | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | -| gemset | `test` | Optional, gets the current RVM gemset name. | +| | 예시 | Description | +| ------- | -------- | ----------------------------------------------------------- | +| version | `v2.5.1` | The version of `ruby` | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | +| gemset | `test` | Optional, gets the current RVM gemset name. | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4068,23 +4171,24 @@ symbol = '🔺 ' ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). +The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🦀 '` | 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. | -| `style` | `'bold red'` | The style for the module. | -| `disabled` | `false` | Disables the `rust` module. | +| `기호` | `'🦀 '` | 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. | +| `style` | `'bold red'` | The style for the module. | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -4094,9 +4198,9 @@ By default the `rust` module shows the currently installed version of [Rust](htt | numver | `1.51.0` | The numeric component of the `rustc` version | | toolchain | `beta` | The toolchain version | | 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4109,7 +4213,8 @@ format = 'via [⚙️ $version](red bold)' ## Scala -The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -4117,26 +4222,26 @@ The `scala` module shows the currently installed version of [Scala](https://www. ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. | +| 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` | -| `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 module. | -| `기호` | `'🆂 '` | A format string representing the symbol of Scala. | -| `style` | `'red dimmed'` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| `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 module. | +| `기호` | `'🆂 '` | A format string representing the symbol of Scala. | +| `style` | `'red dimmed'` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `2.13.5` | The version of `scala` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `2.13.5` | The version of `scala` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4151,36 +4256,37 @@ 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 -| Option | Default | Description | -| ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ | -| `bash_indicator` | `'bsh'` | A format string used to represent bash. | -| `fish_indicator` | `'fsh'` | A format string used to represent fish. | -| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | -| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | +| Option | Default | Description | +| ---------------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `bash_indicator` | `'bsh'` | A format string used to represent bash. | +| `fish_indicator` | `'fsh'` | A format string used to represent fish. | +| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | +| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `pwsh_indicator` | | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. | -| `ion_indicator` | `'ion'` | A format string used to represent ion. | -| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | -| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | -| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. | -| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | -| `nu_indicator` | `'nu'` | A format string used to represent nu. | -| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. | -| `format` | `'[$indicator]($style) '` | The format for the module. | -| `style` | `'white bold'` | The style for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| `ion_indicator` | `'ion'` | A format string used to represent ion. | +| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | +| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | +| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. | +| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | +| `nu_indicator` | `'nu'` | A format string used to represent nu. | +| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. | +| `format` | `'[$indicator]($style) '` | The format for the module. | +| `style` | `'white bold'` | The style for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables -| | Default | Description | -| --------- | ------- | ---------------------------------------------------------- | +| | Default | Description | +| --------- | ------- | -------------------------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| style\* | | Mirrors the value of option `style`. | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4199,29 +4305,30 @@ 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. +> [!TIP] This module is disabled by default. +> To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| --------------- | ---------------------------- | ------------------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `'[$symbol$shlvl]($style) '` | The format for the module. | -| `기호` | `'↕️ '` | 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 | -| `style` | `'bold yellow'` | The style for the module. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Option | Default | Description | +| --------------- | ---------------------------- | ----------------------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `'[$symbol$shlvl]($style) '` | The format for the module. | +| `기호` | `'↕️ '` | 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 | +| `style` | `'bold yellow'` | The style for the module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables -| | 예시 | Description | -| --------- | --- | ------------------------------------ | -| shlvl | `3` | The current value of `SHLVL` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | --- | ------------------------------------ | +| shlvl | `3` | The current value of `SHLVL` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4253,22 +4360,22 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu ### Options -| Option | Default | Description | -| ---------- | -------------------------------- | ------------------------------------------------ | +| Option | Default | Description | +| ---------- | -------------------------------- | ---------------------------------------------------------------- | | `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. | -| `기호` | `''` | A format string displayed before the image name. | +| 기호 | `''` | A format string displayed before the image name. | | `style` | `'bold dimmed blue'` | The style for the module. | | `disabled` | `false` | Disables the `singularity` module. | ### Variables -| | 예시 | Description | -| --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current Singularity image | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------------ | ------------------------------------ | +| env | `centos.img` | The current Singularity image | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4287,27 +4394,27 @@ The `solidity` module shows the currently installed version of [Solidity](https: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `기호` | `'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. | -| `style` | `'bold blue'` | The style for the module. | -| `disabled` | `false` | Disables this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `기호` | `'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. | +| `style` | `'bold blue'` | The style for the module. | +| `disabled` | `false` | Disables this module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v0.8.1` | The version of `solidity` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v0.8.1` | The version of `solidity` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4323,13 +4430,13 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `기호` | `'🅢 '` | The symbol used before the environment name. | -| `style` | `'bold blue'` | The style for the module. | -| `format` | `'via [$symbol$environment]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `spack` module. | +| 기호 | `'🅢 '` | The symbol used before the environment name. | +| `style` | `'bold blue'` | The style for the module. | +| `format` | `'via [$symbol$environment]($style) '` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | ### Variables @@ -4337,9 +4444,9 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat | ----------- | ------------ | ------------------------------------ | | environment | `astronauts` | The current spack environment | | 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4352,48 +4459,51 @@ format = '[$symbol$environment](dimmed blue) ' ## Status -The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 -| Option | Default | Description | -| --------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `format` | `'[$symbol$status]($style) '` | The format of the module | -| `기호` | `'❌'` | The symbol displayed on program error | -| `success_symbol` | `''` | The symbol displayed on program success | -| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable | -| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found | -| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) | -| `signal_symbol` | `'⚡'` | The symbol displayed on any signal | -| `style` | `'bold red'` | The style for the module. | -| `success_style` | | The style used on program success (defaults to `style` if unset). | -| `failure_style` | | The style used on program failure (defaults to `style` if unset). | -| `recognize_signal_code` | `true` | Enable signal mapping from exit code | -| `map_symbol` | `false` | Enable symbols mapping from exit code | -| `pipestatus` | `false` | Enable pipestatus reporting | -| `pipestatus_separator` | | | The symbol used to separate pipestatus segments (supports formatting) | -| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '` | The format of the module when the command is a pipeline | -| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments | -| `disabled` | `true` | Disables the `status` module. | +| Option | Default | Description | +| --------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `format` | `'[$symbol$status]($style) '` | The format of the module | +| `기호` | `'❌'` | The symbol displayed on program error | +| `success_symbol` | `''` | The symbol displayed on program success | +| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable | +| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found | +| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) | +| `signal_symbol` | `'⚡'` | The symbol displayed on any signal | +| `style` | `'bold red'` | The style for the module. | +| `success_style` | | The style used on program success (defaults to `style` if unset). | +| `failure_style` | | The style used on program failure (defaults to `style` if unset). | +| `recognize_signal_code` | `true` | Enable signal mapping from exit code | +| `map_symbol` | `false` | Enable symbols mapping from exit code | +| `pipestatus` | `false` | Enable pipestatus reporting | +| `pipestatus_separator` | | | The symbol used to separate pipestatus segments (supports formatting) | +| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '` | The format of the module when the command is a pipeline | +| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments | +| `disabled` | `true` | Disables the `status` module. | ### Variables -| | 예시 | Description | -| -------------- | ------- | -------------------------------------------------------------------------------------------- | -| status | `127` | The exit code of the last command | -| hex_status | `0x7F` | The exit code of the last command in hex | -| int | `127` | The exit code of the last command | -| common_meaning | `ERROR` | Meaning of the code if not a signal | -| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | -| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | -| maybe_int | `7` | Contains the exit code number when no meaning has been found | -| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `success_style` on program success and `failure_style` otherwise | +| | 예시 | Description | +| ----------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------- | +| status | `127` | The exit code of the last command | +| hex_status | `0x7F` | The exit code of the last command in hex | +| int | `127` | The exit code of the last command | +| common_meaning | `ERROR` | Meaning of the code if not a signal | +| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | +| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | +| maybe_int | `7` | Contains the exit code number when no meaning has been found | +| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format | +| 기호 | | Mirrors the value of option `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 +\*: This variable can only be used as a part of a style string ### 예시 @@ -4411,28 +4521,30 @@ disabled = false ## Sudo -The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. +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 -| Option | Default | Description | -| --------------- | ------------------------ | ------------------------------------------------------- | -| `format` | `'[as $symbol]($style)'` | The format of the module | -| `기호` | `'🧙 '` | The symbol displayed when credentials are cached | +| Option | Default | Description | +| --------------- | ------------------------ | ----------------------------------------------------------------------- | +| `format` | `'[as $symbol]($style)'` | The format of the module | +| `기호` | `'🧙 '` | The symbol displayed when credentials are cached | | `style` | `'bold blue'` | The style for the module. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | | `disabled` | `true` | Disables the `sudo` module. | ### Variables -| | 예시 | Description | -| --------- | -- | ------------------------------------ | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -- | ------------------------------------ | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4456,33 +4568,34 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). +The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'🐦 '` | 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. | -| `style` | `'bold 202'` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| `기호` | `'🐦 '` | 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. | +| `style` | `'bold 202'` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v5.2.4` | The version of `swift` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v5.2.4` | The version of `swift` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4495,9 +4608,11 @@ 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. It supports both Hashicorp Terraform and OpenTofu for version detection. +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/OpenTofu version is not shown, since this is slow for current versions 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: @@ -4506,17 +4621,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. | +| 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. | +| 기호 | `'💠'` | 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 @@ -4525,9 +4640,9 @@ By default the module will be shown if any of the following conditions are met: | version | `v0.12.24` | The version of `terraform` | | workspace | `default` | The current Terraform workspace | | 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4551,35 +4666,40 @@ format = 'via [$symbol$workspace]($style) ' ## 시간 -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +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 -| Option | Default | Description | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | The format string for the module. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `'bold yellow'` | The style for the module time | +| Option | Default | Description | +| ----------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | | `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. +Manually setting `time_format` will override the `use_12hr` setting. ### Variables -| | 예시 | Description | -| --------- | ---------- | ----------------------------------- | -| 시간 | `13:08:10` | The current time. | +| | 예시 | Description | +| ------- | ---------- | ----------------------------------- | +| 시간 | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 +#### With UTC offset + ```toml # ~/.config/starship.toml @@ -4591,6 +4711,17 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` +#### With Timezone name + +```toml +# ~/.config/starship.toml + +[time] +disabled = false +time_format = '%T' +utc_time_offset = 'Europe/Berlin' +``` + ## Typst The `typst` module shows the current installed version of Typst used in a project. @@ -4602,31 +4733,32 @@ By default, the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'t '` | A format string representing the symbol of Typst | -| `style` | `'bold #0093A7'` | The style for the module. | -| `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. | -| `disabled` | `false` | Disables the `typst` module. | +| `기호` | `'t '` | A format string representing the symbol of Typst | +| `style` | `'bold #0093A7'` | The style for the module. | +| `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. | +| `disabled` | `false` | Disables the `typst` module. | ### Variables -| | 예시 | Description | -| ------------- | --------- | ----------------------------------------------- | -| version | `v0.9.0` | The version of `typst`, alias for typst_version | -| typst_version | `default` | The current Typst version | -| 기호 | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| | 예시 | Description | +| ---------------------------------- | --------- | -------------------------------------------------------------------- | +| version | `v0.9.0` | The version of `typst`, alias for typst_version | +| typst_version | `default` | The current Typst version | +| 기호 | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ## Username -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +The `username` module shows active user's username. +The module will be shown if any of the following conditions are met: - The current user is root/admin - The current user isn't the same as the one that is logged in @@ -4638,20 +4770,20 @@ The `username` module shows active user's username. The module will be shown if ### Options -| Option | Default | Description | -| ----------------- | ----------------------- | --------------------------------------------------------- | -| `style_root` | `'bold red'` | The style used when the user is root/admin. | -| `style_user` | `'bold yellow'` | The style used for non-root users. | +| Option | Default | Description | +| ----------------- | ----------------------- | -------------------------------------------------------------------------------------------- | +| `style_root` | `'bold red'` | The style used when the user is root/admin. | +| `style_user` | `'bold yellow'` | The style used for non-root users. | | `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. | -| `format` | `'[$user]($style) in '` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | -| `aliases` | `{}` | Translate system usernames to something else. | +| `format` | `'[$user]($style) in '` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | +| `aliases` | `{}` | Translate system usernames to something else. | ### Variables -| | 예시 | Description | -| ------- | ------------ | ------------------------------------------------------------------------------------------- | +| | 예시 | Description | +| ------- | ------------ | ----------------------------------------------------------------------------------------------------------- | | `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | | `user` | `'matchai'` | The currently logged-in user ID. | @@ -4673,32 +4805,33 @@ aliases = { "corpuser034g" = "matchai" } ## Vagrant -The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a `Vagrantfile` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'⍱ '` | 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. | -| `style` | `'cyan bold'` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| `기호` | `'⍱ '` | 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. | +| `style` | `'cyan bold'` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables -| | 예시 | Description | -| --------- | ---------------- | ------------------------------------ | -| version | `Vagrant 2.2.10` | The version of `Vagrant` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4711,30 +4844,31 @@ format = 'via [⍱ $version](bold white) ' ## V -The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). +By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.v` extension - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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` | -| `기호` | `'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. | -| `style` | `'blue bold'` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| `기호` | `'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. | +| `style` | `'blue bold'` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables -| | 예시 | Description | -| --------- | ------ | ------------------------------------ | -| version | `v0.2` | The version of `v` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------ | ------------------------------------ | +| version | `v0.2` | The version of `v` | +| `기호` | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | ### 예시 @@ -4747,14 +4881,16 @@ format = 'via [V $version](blue bold) ' ## VCS -> Note the module is enabled by default but **not** included in the default list because that would be a breaking change. Additionally, the exact format of the module may change in the future, for example to handle right-aligned prompt. +> Note the module is enabled by default but **not** included in the default list because that would be a breaking change. +> Additionally, the exact format of the module may change in the future, for example to handle right-aligned prompt. -The `vcs` module displays the current active Version Control System (VCS). The module will be shown only if a configured VCS is currently in use. +The `vcs` module displays the current active Version Control System (VCS). +The module will be shown only if a configured VCS is currently in use. ### Options -| Option | Default | Description | -| ---------------- | ----------------------------------------------------------- | ----------------------------------------------------- | +| Option | Default | Description | +| ---------------- | ----------------------------------------------------------- | --------------------------------------------------------------------- | | `order` | `["git", "hg", "pijul", "fossil"]` | The order in which to search VCSes. | | `fossil_modules` | `"$fossil_branch$fossil_metrics"` | Modules to show when a Fossil repository is found. | | `git_modules` | `"$git_branch$git_commit$git_state$git_metrics$git_status"` | Modules to show when a Git repository is found. | @@ -4786,12 +4922,13 @@ format = ' transcending [$output]($style)' ## VCSH -The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. +The module will be shown only if a repository is currently in use. ### Options -| Option | Default | Description | -| ---------- | -------------------------------- | ------------------------------------------------------ | +| Option | Default | Description | +| ---------- | -------------------------------- | ---------------------------------------------------------------------- | | `기호` | `''` | The symbol used before displaying the repository name. | | `style` | `'bold yellow'` | The style for the module. | | `format` | `'vcsh [$symbol$repo]($style) '` | The format for the module. | @@ -4799,13 +4936,13 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v ### Variables -| | 예시 | Description | -| --------- | ------------------------------------------- | ------------------------------------ | -| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | ------------------------------------------- | ------------------------------------ | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| `기호` | | Mirrors the value of option `symbol` | | style\* | `black bold dimmed` | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4824,55 +4961,56 @@ The `xmake` module shows the currently installed version of [XMake](https://xmak ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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. | +| `기호` | `'△ '` | 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 | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | 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 +\*: 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: +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: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| 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 displaying the version of Zig. | -| `style` | `'bold yellow'` | The style for the module. | -| `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. | +| `기호` | `'↯ '` | The symbol used before displaying the version of Zig. | +| `style` | `'bold yellow'` | The style for the module. | +| `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. | ### Variables -| | 예시 | Description | -| --------- | -------- | ------------------------------------ | -| version | `v0.6.0` | The version of `zig` | -| 기호 | | Mirrors the value of option `symbol` | +| | 예시 | Description | +| ------- | -------- | ------------------------------------ | +| version | `v0.6.0` | The version of `zig` | +| 기호 | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string ### 예시 @@ -4897,46 +5035,50 @@ These modules will be shown if any of the following conditions are met: > [!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 `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. +> [!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] [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. -> +> +> 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 -| Option | Default | Description | -| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. | -| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | -| `shell` | | [See below](#custom-command-shell) | -| `description` | `''` | The description of the module that is shown when running `starship explain`. | -| `unsafe_no_escape` | `false` | When set, command output is not escaped of characters that could be interpreted by the shell. | -| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | -| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | -| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | -| `기호` | `''` | The symbol used before displaying the command output. | -| `style` | `'bold green'` | The style for the module. | -| `format` | `'[$symbol($output )]($style)'` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Default | Description | +| ------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | +| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. | +| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | +| `unsafe_no_escape` | `false` | When set, command output is not escaped of characters that could be interpreted by the shell. | +| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | +| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | +| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | +| `기호` | `''` | The symbol used before displaying the command output. | +| `style` | `'bold green'` | The style for the module. | +| `format` | `'[$symbol($output )]($style)'` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | -| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | +| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | ### Variables -| | Description | -| --------- | -------------------------------------- | -| output | The output of `command` run in `shell` | -| 기호 | Mirrors the value of option `symbol` | +| | Description | +| ------- | -------------------------------------- | +| output | The output of `command` run in `shell` | +| 기호 | Mirrors the value of option `symbol` | | style\* | Mirrors the value of option `style` | -*: This variable can only be used as a part of a style string +\*: This variable can only be used as a part of a style string #### Custom command shell @@ -4949,21 +5091,25 @@ If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd The `command` (and `when`, if applicable) will be passed in on stdin. -If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. +If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. +If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. +This behavior can be avoided by explicitly passing arguments to the shell, e.g. ```toml shell = ['pwsh', '-Command', '-'] ``` > [!WARNING] 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. +> +> 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. ### 예시