summaryrefslogtreecommitdiffstats
path: root/docs/zh-CN/config
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.dev>2023-12-29 03:07:36 +0900
committerGitHub <noreply@github.com>2023-12-28 19:07:36 +0100
commitedefca994e00b67234032783011c37049dd9fb3d (patch)
tree0b04a30f9d5d0d5dbef49c410d8529c547e9eeae /docs/zh-CN/config
parentcc161b635e878967f380f4e0c8dd76c20af16e15 (diff)
docs(i18n): new Crowdin updates (#5358)
* New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Norwegian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Bengali) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations readme.md (Arabic) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations nerd-font.md (Korean) * New translations pure-preset.md (Korean) * New translations tokyo-night.md (Korean) * New translations gruvbox-rainbow.md (Korean) * New translations bracketed-segments.md (Korean) * New translations no-runtimes.md (Korean) * New translations plain-text.md (Korean) * New translations pastel-powerline.md (Korean) * New translations no-nerd-font.md (Korean) * New translations no-empty-icons.md (Korean) * New translations jetpack.md (Korean) * New translations no-nerd-font.md (Spanish) * New translations no-empty-icons.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (German) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Polish) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (French) * New translations readme.md (Russian) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Ukrainian) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (Russian) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Norwegian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Bengali) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Russian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Ukrainian) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (Norwegian) * New translations readme.md (Bengali) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Spanish) * New translations readme.md (French) * New translations readme.md (German) * New translations readme.md (Japanese) * New translations readme.md (Russian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations gruvbox-rainbow.md (Polish) * New translations jetpack.md (Polish) * New translations readme.md (Ukrainian)
Diffstat (limited to 'docs/zh-CN/config')
-rw-r--r--docs/zh-CN/config/README.md337
1 files changed, 251 insertions, 86 deletions
diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md
index 9807ad5dd..b41d3714e 100644
--- a/docs/zh-CN/config/README.md
+++ b/docs/zh-CN/config/README.md
@@ -206,6 +206,13 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts']
| `add_newline` | `true` | 在 shell 提示符之间插入空行。 |
| `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. |
+
+::: tip
+
+If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
+
+:::
### 示例
@@ -253,6 +260,7 @@ $kubernetes\
$directory\
$vcsh\
$fossil_branch\
+$fossil_metrics\
$git_branch\
$git_commit\
$git_state\
@@ -301,6 +309,7 @@ $scala\
$solidity\
$swift\
$terraform\
+$typst\
$vlang\
$vagrant\
$zig\
@@ -314,6 +323,7 @@ $aws\
$gcloud\
$openstack\
$azure\
+$direnv\
$env_var\
$crystal\
$custom\
@@ -351,6 +361,8 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile is read from the `AWS_SSO_PROFILE` env var.
+
### 配置项
| 选项 | 默认值 | 描述 |
@@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | 地区缩写列表，用来显示在 AWS 主机名之后。 |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | 此组件的样式。 |
-| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
+| `expiration_symbol` | `'X'` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | 禁用 `AWS` 组件。 |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -620,17 +632,17 @@ The `c` module shows some information about your C compiler. By default the modu
### 配置项
-| 选项 | 默认值 | 描述 |
-| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `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'` | 此组件的样式。 |
-| `disabled` | `false` | Disables the `c` module. |
+| 选项 | 默认值 | 描述 |
+| ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `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'` | 此组件的样式。 |
+| `disabled` | `false` | Disables the `c` module. |
### 变量
@@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/'
```
+## Direnv
+
+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`.
+
+### 配置项
+
+| 选项 | 默认值 | 描述 |
+| ------------------- | -------------------------------------- | ----------------------------------------------------- |
+| `format` | `'[$symbol$loaded/$allowed]($style) '` | 组件格式化模板。 |
+| `符号` | `'direnv '` | The symbol used before displaying the direnv context. |
+| `style` | `'bold orange'` | 此组件的样式。 |
+| `disabled` | `true` | Disables the `direnv` module. |
+| `detect_extensions` | `[]` | Which extensions should trigger this module. |
+| `detect_files` | `['.envrc']` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this module. |
+| `allowed_msg` | `'allowed'` | The message displayed when an rc file is 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. |
+
+### 变量
+
+| 字段 | 示例 | 描述 |
+| --------- | ------------------- | --------------------------------------- |
+| 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. |
+| 符号 | | `symbol`对应值. |
+| style\* | `red bold` | `style`对应值. |
+
+*: 此变量只能作为样式字符串的一部分使用
+
+### 示例
+
+```toml
+# ~/.config/starship.toml
+
+[direnv]
+disabled = false
+```
+
## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use).
@@ -1435,7 +1488,7 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe
| `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'` | 此组件的样式。 |
-| `detect_extensions` | `[fnl]` | Which extensions should trigger this 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 modules. |
| `disabled` | `false` | Disables the `fennel` module. |
@@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = ''
```
+## Fossil Metrics
+
+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.
+
+### 配置项
+
+| 选项 | 默认值 | 描述 |
+| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
+| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | 组件格式化模板。 |
+| `added_style` | `'bold green'` | The style for the added count. |
+| `deleted_style` | `'bold red'` | The style for the deleted count. |
+| `only_nonzero_diffs` | `true` | Render status only for changed items. |
+| `disabled` | `true` | Disables the `fossil_metrics` module. |
+
+### 变量
+
+| 字段 | 示例 | 描述 |
+| ----------------- | --- | ------------------------------------------- |
+| 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` |
+
+*: 此变量只能作为样式字符串的一部分使用
+
+### 示例
+
+```toml
+# ~/.config/starship.toml
+
+[fossil_metrics]
+added_style = 'bold blue'
+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.
-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 be active when one of the environment variables has been set.
+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.
### 配置项
@@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| 选项 | 默认值 | 描述 |
| ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | 组件格式化模板。 |
-| `符号` | `"🐃 "` | A format string representing the symbol of guix-shell. |
-| `style` | `"yellow bold"` | 此组件的样式。 |
+| `符号` | `'🐃 '` | A format string representing the symbol of guix-shell. |
+| `style` | `'yellow bold'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `guix_shell` module. |
### 变量
@@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
-| `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. |
+| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 |
+| `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"` | 此组件的样式。 |
+| `detect_folders` | `['gradle']` | Which folders should trigger this module. |
+| `style` | `'bold bright-cyan'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
@@ -2034,13 +2122,13 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o
| 选项 | 默认值 | 描述 |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `detect_extensions` | `["hx", "hxml"]` | Which extensions should trigger this module. |
-| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Which folders should trigger this modules. |
-| `符号` | `"⌘ "` | A format string representing the symbol of Helm. |
-| `style` | `"bold fg:202"` | 此组件的样式。 |
+| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `detect_extensions` | `['hx', 'hxml']` | Which extensions should trigger this module. |
+| `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
+| `符号` | `'⌘ '` | A format string representing the symbol of Helm. |
+| `style` | `'bold fg:202'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `haxe` module. |
### 变量
@@ -2107,14 +2195,15 @@ format = 'via [⎈ $version](bold white) '
### 配置项
-| 选项 | 默认值 | 描述 |
-| ------------ | -------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `ssh_only` | `true` | 仅在连接到 SSH 会话时显示主机名。 |
-| `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 '` | 组件格式化模板。 |
-| `style` | `'bold dimmed green'` | 此组件的样式。 |
-| `disabled` | `false` | 禁用 `hostname` 组件。 |
+| 选项 | 默认值 | 描述 |
+| ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `ssh_only` | `true` | 仅在连接到 SSH 会话时显示主机名。 |
+| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
+| `trim_at` | `'.'` | 当主机名过长被截断时，会截断成第一次匹配该字符串之前的主机名。 `'.'` will stop after the first dot. `''` will disable any truncation. |
+| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. |
+| `format` | `'[$ssh_symbol$hostname]($style) in '` | 组件格式化模板。 |
+| `style` | `'bold dimmed green'` | 此组件的样式。 |
+| `disabled` | `false` | 禁用 `hostname` 组件。 |
### 变量
@@ -2126,7 +2215,9 @@ format = 'via [⎈ $version](bold white) '
*: 此变量只能作为样式字符串的一部分使用
-### 示例
+### Examples
+
+#### Always show the hostname
```toml
# ~/.config/starship.toml
@@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false
```
+#### Hide the hostname in remote tmux sessions
+
+```toml
+# ~/.config/starship.toml
+
+[hostname]
+ssh_only = false
+detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
+disabled = false
+```
+
## Java
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met:
@@ -2323,7 +2425,7 @@ 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
@@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### 配置项
+::: warning
+
+The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
+
+:::
+
| 选项 | 默认值 | 描述 |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `符号` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | 组件格式化模板。 |
| `style` | `'cyan bold'` | 此组件的样式。 |
-| `context_aliases` | `{}` | Table of context aliases to display. |
-| `user_aliases` | `{}` | Table of user aliases to display. |
+| `context_aliases`* | `{}` | Table of context aliases to display. |
+| `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
+| `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.
+
+To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list:
+
+| 字段 | 描述 |
+| ----------------- | ---------------------------------------------------------------------------------------- |
+| `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. |
+
+Note that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)).
+
### 变量
| 字段 | 示例 | 描述 |
@@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false
-[kubernetes.context_aliases]
-'dev.local.cluster.k8s' = 'dev'
-'.*/openshift-cluster/.*' = 'openshift'
-'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
-[kubernetes.user_aliases]
-'dev.local.cluster.k8s' = 'dev'
-'root/.*' = 'root'
+contexts = [
+ { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
+]
```
Only show the module in directories that contain a `k8s` file.
@@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s']
```
-#### Regex Matching
-
-Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
-
-The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
+#### Kubernetes Context specific config
-Long and automatically generated cluster names can be identified and shortened using regular expressions:
+The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.
```toml
-[kubernetes.context_aliases]
-# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
-'.*/openshift-cluster/.*' = 'openshift'
-# Or better, to rename every OpenShift cluster at once:
-'.*/(?P<var_cluster>[\w-]+)/.*' = '$var_cluster'
+# ~/.config/starship.toml
+[[kubernetes.contexts]]
+# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
+# equals "admin_user"
+context_pattern = "production"
+user_pattern = "admin_user"
+style = "bold red"
+context_alias = "prod"
+user_alias = "admin"
+
+[[kubernetes.contexts]]
+# "green" style + a different symbol when Kubernetes current context name contains openshift
+context_pattern = ".*openshift.*"
+style = "green"
+symbol = "💔 "
+context_alias = "openshift"
+
+[[kubernetes.contexts]]
+# Using capture groups
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
-'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
+context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
+context_alias = "gke-$cluster"
```
## Line Break
@@ -2730,7 +2861,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `nodejs` 组件。 |
-| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. |
+| `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |
### 变量
@@ -2890,8 +3021,8 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known
| 选项 | 默认值 | 描述 |
| ---------- | --------------------- | ------------------------------------------------------ |
-| `format` | `"[$symbol]($style)"` | 组件格式化模板。 |
-| `style` | `"bold white"` | 此组件的样式。 |
+| `format` | `'[$symbol]($style)'` | 组件格式化模板。 |
+| `style` | `'bold white'` | 此组件的样式。 |
| `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. |
@@ -3245,7 +3376,7 @@ By default the module will be shown if any of the following conditions are met:
| `符号` | `'🐍 '` | 用于表示Python的格式化字符串。 |
| `style` | `'yellow bold'` | 此组件的样式。 |
| `pyenv_version_name` | `false`