1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-24 11:05:27 +00:00

New translations README.md (Chinese Traditional)

This commit is contained in:
Matan Kushner 2023-09-03 02:05:53 +01:00
parent 468bc1607f
commit 7cb0ea01ab

View File

@ -1636,9 +1636,9 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
very-long-project-name = 'vlpn'
```
## Git Branch
## Git 分支
The `git_branch` module shows the active branch of the repo in your current directory.
`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。
### 選項
@ -1652,7 +1652,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
| `truncation_symbol` | `'…'` | 用來指示分支名稱被縮減的符號。 You can use `''` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
| `disabled` | `false` | Disables the `git_branch` module. |
| `disabled` | `false` | 停用 `git_branch` 模組。 |
### Variables
@ -1717,7 +1717,7 @@ tag_symbol = '🔖 '
## Git State
The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
`git_state` 模組會顯示在 git 儲存庫中的資料夾內以及會在有作業正在進行時顯示像是_REBASING_、_BISECTING_ 等等。 如果有進展的資訊 (像是 REBASING 3/10),也會一併顯示出來。
### 選項
@ -1732,7 +1732,7 @@ The `git_state` module will show in directories which are part of a git reposito
| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `'bold yellow'` | 這個模組的風格。 |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. |
| `disabled` | `false` | Disables the `git_state` module. |
| `disabled` | `false` | 停用 `git_state` 模組。 |
### Variables
@ -1761,7 +1761,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
:::
@ -1799,7 +1799,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
## Git Status
The `git_status` module shows symbols representing the state of the repo in your current directory.
`git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。
::: tip
@ -1812,7 +1812,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| Option | 預設 | 說明 |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `'='` | This branch has merge conflicts. |
| `conflicted` | `'='` | 這個分支有合併衝突。 |
| `ahead` | `'⇡'` | The format of `ahead` |
| `behind` | `'⇣'` | The format of `behind` |
| `diverged` | `'⇕'` | The format of `diverged` |
@ -1826,7 +1826,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | 這個模組的風格。 |
| `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. |
| `disabled` | `false` | 停用 `git_status` 模組。 |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
### Variables
@ -1927,7 +1927,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | 這個模組的風格。 |
| `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
| `disabled` | `false` | 停用 `golang` 模組。 |
### Variables
@ -2139,24 +2139,24 @@ format = 'via [⎈ $version](bold white) '
## 主機名稱
The `hostname` module shows the system hostname.
`hostname` 模組顯示系統的主機名稱。
### 選項
| Option | 預設 | 說明 |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `hostname` module. |
| Option | 預設 | 說明 |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | 只在連接到一個 SSH session 時顯示主機名稱。 |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | 擷取出主機名稱的斷點,以第一個符合的為準。 `'.'` will stop after the first dot. `''` will disable any truncation |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `hostname` 模組。 |
### Variables
| 變數 | 範例 | 說明 |
| ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer |
| 主機名稱 | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` |
| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |
@ -2192,7 +2192,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `'☕ '` | A format string representing the symbol of Java |
| `style` | `'red dimmed'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `java` module. |
| `disabled` | `false` | 停用 `java` 模組。 |
### Variables
@ -2213,9 +2213,9 @@ The `java` module shows the currently installed version of [Java](https://www.or
symbol = '🌟 '
```
## Jobs
## 工作
The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running.
`jobs` 模組顯示現在正在執行中的工作。 這個模組只會在有背景工作正在執行時顯示。 The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running.
The default functionality is:
@ -2239,13 +2239,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will
| Option | 預設 | 說明 |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------ |
| `threshold`* | `1` | Show number of jobs if exceeded. |
| `threshold`* | `1` | 在超過指定值時顯示工作數量。 |
| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |
| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |
| `format` | `'[$symbol$number]($style) '` | The format for the module. |
| `symbol` | `'✦'` | The string used to represent the `symbol` variable. |
| `style` | `'bold blue'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `jobs` module. |
| `disabled` | `false` | 停用 `jobs` 模組。 |
*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.
@ -2363,7 +2363,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions.
@ -2473,15 +2473,15 @@ context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
context_alias = "gke-$cluster"
```
## Line Break
## 換行
The `line_break` module separates the prompt into two lines.
`line_break` 模組將提示字元分成兩行。
### 選項
| Option | 預設 | 說明 |
| ---------- | ------- | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
| Option | 預設 | 說明 |
| ---------- | ------- | ----------------------------- |
| `disabled` | `false` | 停用 `line_break` 模組,讓提示字元變成一行。 |
### 範例
@ -2566,27 +2566,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
format = 'via [🌕 $version](bold blue) '
```
## Memory Usage
## 記憶體使用量
The `memory_usage` module shows current system memory and swap usage.
`memory_usage` 模組顯示現在系統記憶體與 swap 的使用量。
By default the swap usage is displayed if the total system swap is non-zero.
預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
:::
### 選項
| Option | 預設 | 說明 |
| ----------- | ----------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | The format for the module. |
| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |
| `style` | `'bold dimmed white'` | 這個模組的風格。 |
| `disabled` | `true` | Disables the `memory_usage` module. |
| Option | 預設 | 說明 |
| ----------- | ----------------------------------------------- | -------------------------- |
| `threshold` | `75` | 將記憶體使用量隱藏,除非使用量超過指定值。 |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | The format for the module. |
| `symbol` | `'🐏'` | 顯示在記憶體使用量之前的符號。 |
| `style` | `'bold dimmed white'` | 這個模組的風格。 |
| `disabled` | `true` | 停用 `memory_usage` 模組。 |
### Variables
@ -2733,7 +2733,7 @@ symbol = '🎣 '
## Nix-shell
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment.
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. 這個模組會在 nix-shell 環境中顯示。
### 選項
@ -2745,7 +2745,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. |
| `disabled` | `false` | Disables the `nix_shell` module. |
| `disabled` | `false` | 停用 `nix_shell` 模組。 |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables
@ -2794,7 +2794,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `nodejs` module. |
| `disabled` | `false` | 停用 `nodejs` 模組。 |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. |
### Variables
@ -2947,7 +2947,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
:::
@ -3037,9 +3037,9 @@ Windows = " "
Arch = "Arch is the best! "
```
## Package Version
## 套件版本
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現,並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -3066,11 +3066,11 @@ The `package` module is shown when the current directory is the repository for a
| Option | 預設 | 說明 |
| ----------------- | --------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | The format for the module. |
| `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
| `symbol` | `'📦 '` | 顯示在套件的版本之前的符號。 |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold 208'` | 這個模組的風格。 |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
| `disabled` | `false` | 停用 `package` 模組。 |
### Variables
@ -3309,13 +3309,13 @@ By default the module will be shown if any of the following conditions are met:
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | 這個模組的風格。 |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | Which extensions should trigger this module |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `disabled` | `false` | Disables the `python` module. |
| `disabled` | `false` | 停用 `python` 模組。 |
::: tip
@ -3454,7 +3454,7 @@ 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 current directory contains a file with `.red` or `.reds` extension
@ -3492,7 +3492,7 @@ 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/). 這個模組將在下列其中一個條件滿足時顯示:
- 目前資料夾中有一個 `Gemfile` 檔案
- The current directory contains a `.ruby-version` file
@ -3513,7 +3513,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. |
| `style` | `'bold red'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `ruby` module. |
| `disabled` | `false` | 停用 `ruby` 模組。 |
### Variables
@ -3536,7 +3536,7 @@ 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/). 這個模組將在下列其中一個條件滿足時顯示:
- 目前資料夾中有一個 `Cargo.toml` 檔案
- 現在資料夾中包含一個檔案具有 `.rs` 副檔名
@ -3552,7 +3552,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold red'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `rust` module. |
| `disabled` | `false` | 停用 `rust` 模組。 |
### Variables
@ -3621,7 +3621,7 @@ The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
:::
@ -3826,7 +3826,7 @@ The `status` module displays the exit code of the previous command. If $success_
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
:::
@ -3887,7 +3887,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
:::
@ -3932,7 +3932,7 @@ 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 current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
@ -4030,25 +4030,25 @@ format = '[🏎💨 $workspace]($style) '
## 時間
The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
`time` 模組顯示目前的**當地**時間. `format` 設定值被 [`chrono`](https://crates.io/crates/chrono) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`
:::
### 選項
| Option | 預設 | 說明 |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | The format string for the module. |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `'bold yellow'` | The style for the module time |
| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Disables the `time` module. |
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
| Option | 預設 | 說明 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | The format string for the module. |
| `use_12hr` | `false` | 啟用 12 小時格式。 |
| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 |
| `style` | `'bold yellow'` | 這個模組的時間的風格。 |
| `utc_time_offset` | `'local'` | 設定相對於 UTC 的時差。 Range from -24 &lt; x &lt; 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 |
| `disabled` | `true` | 停用 `time` 模組。 |
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting.
@ -4056,7 +4056,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de
| 變數 | 範例 | 說明 |
| --------- | ---------- | ----------------------------------- |
| time | `13:08:10` | The current time. |
| 時間 | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@ -4074,9 +4074,9 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00'
```
## Username
## 使用者名稱
The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
`username` 模組顯示現在使用中的使用者名稱。 這個模組將在下列其中一個條件滿足時顯示:
- The current user is root/admin
- 目前使用者並非登入時的使用者
@ -4094,10 +4094,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| Option | 預設 | 說明 |
| ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `'bold red'` | The style used when the user is root/admin. |
| `style_user` | `'bold yellow'` | The style used for non-root users. |
| `style_user` | `'bold yellow'` | 非 root 使用者時使用的風格。 |
| `format` | `'[$user]($style) in '` | The format for the module. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
| `show_always` | `false` | 總是顯示 `username` 模組。 |
| `disabled` | `false` | 停用 `username` 模組。 |
### Variables
@ -4227,7 +4227,7 @@ format = '[🆅 $repo](bold blue) '
## 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 current directory contains a `.zig` file
@ -4309,7 +4309,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `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` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `說明` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |