haskal
/
starship
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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)
This commit is contained in:
Matan Kushner 2023-12-29 03:07:36 +09:00 committed by GitHub
parent cc161b635e
commit edefca994e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
152 changed files with 13151 additions and 2573 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

279
docs/ar-SA/config/README.md
View File

@ -206,6 +206,13 @@ This is the list of prompt-wide configuration options.
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $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 [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.
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | The style for the module. | | `style` | `'bold yellow'` | The style for the module. |
| `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` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | | `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders 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 | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | The style for the module. | | `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -671,7 +683,7 @@ The character will tell you whether the last command was successful or not. It c
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). 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). `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).
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Options
| Option | الافتراضي | الوصف |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. |
| `symbol` | `'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. |
| `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. |
### Variables
| Variable | مثال | الوصف |
| --------- | ------------------- | --------------------------------------- |
| 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 | | 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
### مثال
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `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_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Options
| Option | الافتراضي | الوصف |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `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. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| Variable | مثال | الوصف |
| ----------------- | ---- | ------------------------------------------- |
| 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
### مثال
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Options ### Options
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | The format for the module. | | `format` | `'via [$symbol]($style) '` | The format for the module. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | | `detect_folders` | `['gradle']` | Which folders should trigger this module. |
| `style` | `"bold bright-cyan"` | The style for the module. | | `style` | `'bold bright-cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `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_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_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. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | The style for the module. | | `style` | `'bold fg:202'` | The style for the module. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `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. | | `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 | | `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. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | The style for the module. | | `style` | `'bold dimmed green'` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2126,7 +2215,9 @@ The `hostname` module shows the system hostname.
*: 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
### مثال ### Examples
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## 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:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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 ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Options ### Options
::: تحذير
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `'cyan bold'` | The style for the module. | | `style` | `'cyan bold'` | The style for the module. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `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:
| Variable | الوصف |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `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. |
| `symbol` | 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)).
### Variables ### Variables
| Variable | مثال | الوصف | | Variable | مثال | الوصف |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## 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. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `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 ### Variables
@ -2890,8 +3021,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | The format for the module. | | `format` | `'[$symbol]($style)'` | The format for the module. |
| `style` | `"bold white"` | The style for the module. | | `style` | `'bold white'` | The style for the module. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `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:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `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_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_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
@ -3563,11 +3694,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `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` | | `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. | | `detect_extensions` | `['sol']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- The current directory contains a `template.typ` file
- The current directory contains any `*.typ` file
### Options
| Option | الافتراضي | الوصف |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `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 `daml` module. |
### Variables
| Variable | مثال | الوصف |
| ------------- | ----------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `الافتراضي` | The current Typst version |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
## Username ## 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:

16
docs/ar-SA/guide/README.md
View File

@ -20,7 +20,7 @@
<a href="https://repology.org/project/starship/versions" <a href="https://repology.org/project/starship/versions"
><img ><img
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="واقع التغليف" /></a
><br /> ><br />
<a href="https://discord.gg/starship" <a href="https://discord.gg/starship"
><img ><img
@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="تابع @StarshipPrompt على تويتر" alt="تابع @StarshipPrompt على تويتر"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -87,7 +92,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
alt="Italiano" alt="الإيطالية"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -168,7 +171,7 @@
- **Easy:** سريع التثبيت – استخدمها في دقائق معدودة. - **Easy:** سريع التثبيت – استخدمها في دقائق معدودة.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>استكشف مستندات Starship&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/config/"><strong>تصفّح مستندات Starship&nbsp;&nbsp;▶</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>
@ -229,6 +232,7 @@ curl -sS https://starship.rs/install.sh | sh
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>
@ -299,7 +303,7 @@ load(io.popen('starship init cmd'):read("*a"))()
<details> <details>
<summary>Elvish</summary> <summary>Elvish</summary>
أضف ما يلي إلى نهاية `~/.elvish/rc.elv`: أضف ما يلي إلى نهاية الملف `~/.elvish/rc.elv`:
```sh ```sh
eval (starship init elvish) eval (starship init elvish)

6
docs/ar-SA/presets/README.md
View File

@ -63,3 +63,9 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/ar-SA/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### المتطلبات الأساسية
- تثبيت [Nerd Font](https://www.nerdfonts.com/) وتمكينه في موجه الأوامر الخاصة بك
### Configuration
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/ar-SA/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Return to Presets](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Configuration
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

188
docs/bn-BD/README.md Normal file
View File

@ -0,0 +1,188 @@
---
home: true
heroImage: /logo.svg
heroText:
tagline: আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট!
actionText: Get Started →
actionLink: ./guide/
features:
-
title: Compatibility First
details: Works on the most common shells on the most common operating systems. Use it everywhere!
-
title: Rust-Powered
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
-
title: Customizable
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
#Used for the description meta tag, for SEO
metaTitle: "Starship: Cross-Shell Prompt"
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.
---
<div class="center">
<video class="demo-video" muted autoplay loop playsinline>
<source src="/demo.webm" type="video/webm">
<source src="/demo.mp4" type="video/mp4">
</video>
</div>
### পূর্বশর্ত
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal.
### Quick Install
1. Install the **starship** binary:
#### Install Latest Version
With Shell:
```sh
curl -sS https://starship.rs/install.sh | sh
```
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
#### Install via Package Manager
With [Homebrew](https://brew.sh/):
```sh
brew install starship
```
With [Winget](https://github.com/microsoft/winget-cli):
```powershell
winget install starship
```
1. Add the init script to your shell's config file:
#### Bash
`~/.bashrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
# ~/.bashrc
eval "$(starship init bash)"
```
#### Fish
`~/.config/fish/config.fish` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
# ~/.config/fish/config.fish
starship init fish | source
```
#### Zsh
`~/.zshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
# ~/.zshrc
eval "$(starship init zsh)"
```
#### Powershell
Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh
Invoke-Expression (&starship init powershell)
```
#### Ion
`~/.config/ion/initrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
# ~/.config/ion/initrc
eval $(starship init ion)
```
#### Elvish
::: warning
Only elvish v0.18 or higher is supported.
:::
`~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
# ~/.elvish/rc.elv
eval (starship init elvish)
```
#### Tcsh
`~/.tcshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
# ~/.tcshrc
eval `starship init tcsh`
```
#### Nushell
::: warning
This will change in the future. Only Nushell v0.78+ is supported.
:::
আপনার Nushell env ফাইলের (Nushell এ `$nu.env-path` কমান্ডটি রান করে ফাইলটি খুঁজে বের করুন) শেষে নিম্নলিখিত লাইনগুলি যোগ করুন:
```sh
mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu
```
এরপর আপনার Nushell কনফিগের (Nushell এ `$nu.config-path` কমান্ডটি রান করে ফাইলটি খুঁজে বের করুন) শেষে নিম্নলিখিত লাইনটি যোগ করুন:
```sh
use ~/.cache/starship/init.nu
```
#### Xonsh
`~/.xonshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
# ~/.xonshrc
execx($(starship init xonsh))
```
#### Cmd
আপনাকে Cmd এর সাথে [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) ব্যবহার করতে হবে । Add the following to a file `starship.lua` and place this file in Clink scripts directory:
```lua
-- starship.lua
load(io.popen('starship init cmd'):read("*a"))()
```

284
docs/bn-BD/advanced-config/README.md Normal file
View File

@ -0,0 +1,284 @@
# Advanced Configuration
While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship.
::: warning
The configurations in this section are subject to change in future releases of Starship.
:::
## TransientPrompt in PowerShell
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put this statement in your `$PROFILE`. Transience can be disabled on-the-fly with `Disable-TransientPrompt`.
By default, the left side of input gets replaced with `>`. To customize this, define a new function called `Invoke-Starship-TransientFunction`. For example, to display Starship's `character` module here, you would do
```powershell
function Invoke-Starship-TransientFunction {
&starship module character
}
Invoke-Expression (&starship init powershell)
Enable-TransientPrompt
```
## TransientPrompt and TransientRightPrompt in Cmd
Clink allows you to replace the previous-printed prompt with custom strings. This is useful in cases where all the prompt information is not always needed. To enable this, run `clink set prompt.transient <value>` where \<value\> can be one of:
- `always`: always replace the previous prompt
- `same_dir`: replace the previous prompt only if the working directory is same
- `off`: do not replace the prompt (i.e. turn off transience)
You need to do this only once. Make the following changes to your `starship.lua` to customize what gets displayed on the left and on the right:
- By default, the left side of input gets replaced with `>`. To customize this, define a new function called `starship_transient_prompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display Starship's `character` module here, you would do
```lua
function starship_transient_prompt_func(prompt)
return io.popen("starship module character"
.." --keymap="..rl.getvariable('keymap')
):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
```
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
```lua
function starship_transient_rprompt_func(prompt)
return io.popen("starship module time"):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
```
## TransientPrompt and TransientRightPrompt in Fish
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `enable_transience` in the shell session. To make it permanent, put this statement in your `~/.config/fish/config.fish`. Transience can be disabled on-the-fly with `disable_transience`.
Note that in case of Fish, the transient prompt is only printed if the commandline is non-empty, and syntactically correct.
- By default, the left side of input gets replaced with a bold-green `❯`. To customize this, define a new function called `starship_transient_prompt_func`. For example, to display Starship's `character` module here, you would do
```fish
function starship_transient_prompt_func
starship module character
end
starship init fish | source
enable_transience
```
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. For example, to display the time at which the last command was started here, you would do
```fish
function starship_transient_rprompt_func
starship module time
end
starship init fish | source
enable_transience
```
## Custom pre-prompt and pre-execution Commands in Cmd
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands in Cmd shell. It is fairly simple to use with Starship. Make the following changes to your `starship.lua` file as per your requirements:
- To run a custom function right before the prompt is drawn, define a new function called `starship_preprompt_user_func`. This function receives the current prompt as a string that you can utilize. For example, to draw a rocket before the prompt, you would do
```lua
function starship_preprompt_user_func(prompt)
print("🚀")
end
load(io.popen('starship init cmd'):read("*a"))()
```
- To run a custom function right before a command is executed, define a new function called `starship_precmd_user_func`. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do
```lua
function starship_precmd_user_func(line)
print("Executing: "..line)
end
load(io.popen('starship init cmd'):read("*a"))()
```
## Custom pre-prompt and pre-execution Commands in Bash
Bash does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do
```bash
function blastoff(){
echo "🚀"
}
starship_precmd_user_func="blastoff"
```
- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal _before_ initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
```bash
function blastoff(){
echo "🚀"
}
trap blastoff DEBUG # Trap DEBUG *before* running starship
set -o functrace
eval $(starship init bash)
set +o functrace
```
## Custom pre-prompt and pre-execution Commands in PowerShell
PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `powershell`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
Create a function named `Invoke-Starship-PreCommand`
```powershell
function Invoke-Starship-PreCommand {
$host.ui.Write("🚀")
}
```
## Change Window Title
Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
First, define a window title change function (identical in bash and zsh):
```bash
function set_win_title(){
echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
}
```
You can use variables to customize this title (`$USER`, `$HOSTNAME`, and `$PWD` are popular choices).
In `bash`, set this function to be the precmd starship function:
```bash
starship_precmd_user_func="set_win_title"
```
In `zsh`, add this to the `precmd_functions` array:
```bash
precmd_functions+=(set_win_title)
```
If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zshrc`) to make it permanent.
For example, if you want to display your current directory in your terminal tab title, add the following snippet to your `~/.bashrc` or `~/.zshrc`:
```bash
function set_win_title(){
echo -ne "\033]0; $(basename "$PWD") \007"
}
starship_precmd_user_func="set_win_title"
```
For Cmd, you can change the window title using the `starship_preprompt_user_func` function.
```lua
function starship_preprompt_user_func(prompt)
console.settitle(os.getenv('USERNAME').."@"..os.getenv('COMPUTERNAME')..": "..os.getcwd())
end
load(io.popen('starship init cmd'):read("*a"))()
```
You can also set a similar output with PowerShell by creating a function named `Invoke-Starship-PreCommand`.
```powershell
# edit $PROFILE
function Invoke-Starship-PreCommand {
$host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
}
Invoke-Expression (&starship init powershell)
```
## Enable Right Prompt
Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
### Example
```toml
# ~/.config/starship.toml
# A minimal left prompt
format = """$character"""
# move the rest of the prompt to the right
right_format = """$all"""
```
Produces a prompt like the following:
```
▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
```
## Continuation Prompt
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`.
Note: `continuation_prompt` should be set to a literal string without any variables.
Note: Continuation prompts are only available in the following shells:
- `bash`
- `zsh`
- `PowerShell`
### Example
```toml
# ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows
continuation_prompt = '▶▶ '
```
## Style Strings
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
- `bold`
- `italic`
- `underline`
- `dimmed`
- `inverted`
- `blink`
- `hidden`
- `strikethrough`
- `bg:<color>`
- `fg:<color>`
- `<color>`
- `none`
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter.
The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. It may become an error to use `none` in conjunction with other tokens in the future.
A color specifier can be one of the following:
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
- A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
- A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
If multiple colors are specified for foreground/background, the last one in the string will take priority.
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app

4484
docs/bn-BD/config/README.md Normal file
View File

File diff suppressed because it is too large Load Diff

122
docs/bn-BD/faq/README.md Normal file
View File

@ -0,0 +1,122 @@
# Frequently Asked Questions
## What is the configuration used in the demo GIF?
- **Terminal Emulator**: [iTerm2](https://iterm2.com/)
- **Theme**: Minimal
- **Color Scheme**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy)
- **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)
- **Shell**: [Fish Shell](https://fishshell.com/)
- **Configuration**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish)
- **Prompt**: [Starship](https://starship.rs/)
## How do I get command completion as shown in the demo GIF?
Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions).
## Do top level `format` and `<module>.disabled` do the same thing?
Yes, they can both be used to disable modules in the prompt. If all you plan to do is disable modules, `<module>.disabled` is the preferred way to do so for these reasons:
- Disabling modules is more explicit than omitting them from the top level `format`
- Newly created modules will be added to the prompt as Starship is updated
## The docs say Starship is cross-shell. Why isn't my preferred shell supported?
The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used.
Here's a small example getting Starship working with bash:
```sh
# Get the status code from the last command executed
STATUS=$?
# Get the number of jobs running.
NUM_JOBS=$(jobs -p | wc -l)
# Set the prompt to the output of `starship prompt`
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
```
The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations.
For a list of all flags accepted by `starship prompt`, use the following command:
```sh
starship prompt --help
```
The prompt will use as much context as is provided, but no flags are "required".
## How do I run Starship on Linux distributions with older versions of glibc?
If you get an error like "_version 'GLIBC_2.18' not found (required by starship)_" when using the prebuilt binary (for example, on CentOS 6 or 7), you can use a binary compiled with `musl` instead of `glibc`:
```sh
curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
```
## Why do I see `Executing command "..." timed out.` warnings?
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](/config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
## I see symbols I don't understand or expect, what do they mean?
If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules.
## Starship is doing something unexpected, how can I debug it?
You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module.
```sh
env STARSHIP_LOG=trace starship module rust
```
If starship is being slow you can try using the `timings` command to see if there is a particular module or command that to blame.
```sh
env STARSHIP_LOG=trace starship timings
```
This will output the trace log and a breakdown of all modules that either took more than 1ms to execute or produced some output.
Finally if you find a bug you can use the `bug-report` command to create a GitHub issue.
```sh
starship bug-report
```
## Why don't I see a glyph symbol in my prompt?
The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that:
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/).
- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice.
- You are using a [Nerd Font](https://www.nerdfonts.com/).
To test your system, run the following commands in a terminal:
```sh
echo -e "\xf0\x9f\x90\x8d"
echo -e "\xee\x82\xa0"
```
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
## How do I uninstall Starship?
Starship is just as easy to uninstall as it is to install in the first place.
1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship.
1. Delete the Starship binary.
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions.
If Starship was installed using the install script, the following command will delete the binary:
```sh
# Locate and delete the starship binary
sh -c 'rm "$(command -v 'starship')"'
```

445
docs/bn-BD/guide/README.md Normal file
View File

@ -0,0 +1,445 @@
<p align="center">
<img
width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
alt="Starship – Cross-shell prompt"
/>
</p>
<p align="center">
<a href="https://github.com/starship/starship/actions"
><img
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
alt="GitHub Actions workflow status"
/></a>
<a href="https://crates.io/crates/starship"
><img
src="https://img.shields.io/crates/v/starship?style=flat-square"
alt="Crates.io version"
/></a>
<a href="https://repology.org/project/starship/versions"
><img
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a
><br />
<a href="https://discord.gg/starship"
><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord"
/></a>
<a href="https://twitter.com/StarshipPrompt"
><img
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Follow @StarshipPrompt on Twitter"
/></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p>
<p align="center">
<a href="https://starship.rs">ওয়েবসাইট</a>
·
<a href="#🚀-installation">ইন্সটল</a>
·
<a href="https://starship.rs/config/"> কনফিগ</a>
</p>
<p align="center">
<a href="https://github.com/starship/starship/blob/master/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
alt="English"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/de-DE/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
alt="Deutsch"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
alt="Español"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
alt="Français"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/id-ID/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
alt="Bahasa Indonesia"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/it-IT/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
alt="Italiano"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/ja-JP/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
alt="日本語"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/pt-BR/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
alt="Português do Brasil"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/ru-RU/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/uk-UA/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ua.png"
alt="Українська"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
alt="Tiếng Việt"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/zh-CN/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
alt="简体中文"
/></a>
&nbsp;
<a
href="https://github.com/starship/starship/blob/master/docs/zh-TW/guide/README.md"
><img
height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
alt="繁體中文"
/></a>
</p>
<h1></h1>
<img
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
alt="Starship with iTerm2 and the Snazzy theme"
width="50%"
align="right"
/>
**আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট!**
- **দ্রুত:** দ্রুত - সত্যি সত্যিই _অনেক_ দ্রুত! 🚀
- **কাস্টমাইজ করার সুবিধা:** প্রম্পটের প্রতিটি দিক কনফিগ করুন মন মত ।
- **ব্যতিক্রমহীন:** যেকোনো অপারেটিং সিস্টেম ও শেলে কাজ করে ।
- **চালাক:** এক নজরে দরকারি সকল তথ্য দেখা যায় ।
- **ফিচার সমৃদ্ধ:** আপনার প্রিয় সকল টুল ব্যবহার করতে পারবেন ।
- **সহজ:** অনায়াসে ইন্সটল করুন – মিনিটের মধ্যে ব্যবহার শুরু করে দিন ।
<p align="center">
<a href="https://starship.rs/config/"><strong>Starship এর ডকুমেন্টেশন ঘুরে দেখুন&nbsp;&nbsp;▶</strong></a>
</p>
<a name="🚀-installation"></a>
## 🚀 ইন্সটল
### পূর্বশর্ত
- আপনার থেকে টার্মিনালে একটি [Nerd Font](https://www.nerdfonts.com/) ব্যবহার করতে হবে (উদাহরণস্বরূপ আপনি [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) টি ব্যবহার করতে পারেন) ।
### ধাপ ১. Starship ইন্সটল করুন
ইনস্টলেশন নির্দেশিকা দেখতে নিচের তালিকা থেকে আপনার অপারেটিং সিস্টেম বাছাই করুন:
<details>
<summary>অ্যান্ড্রয়েড</summary>
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
| রিপোজিটরি | নির্দেশাবলী |
| --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
</details>
<details>
<summary>বিএসডি</summary>
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
| ডিস্ট্রিবিউশন | রিপোজিটরি | নির্দেশাবলী |
| ------------- | -------------------------------------------------------- | --------------------------------- |
| **_যেকোনো_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
</details>
<details>
<summary>লিনাক্স </summary>
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি ইন্সটল করুন:
```sh
curl -sS https://starship.rs/install.sh | sh
```
অথবা, নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
| ডিস্ট্রিবিউশন | রিপোজিটরি | নির্দেশাবলী |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_যেকোনো_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _যেকোনো_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| _যেকোনো_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details>
<details>
<summary>ম্যাক ওএস </summary>
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি ইন্সটল করুন:
```sh
curl -sS https://starship.rs/install.sh | sh
```
অথবা, নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
| রিপোজিটরি | নির্দেশাবলী |
| -------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
</details>
<details>
<summary>উইন্ডোজ</summary>
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি [রিলিজ সেকশনে](https://github.com/starship/starship/releases/latest) থাকা MSI-ইন্সটলার ব্যবহার করে ইন্সটল করুন ।
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
| রিপোজিটরি | নির্দেশাবলী |
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details>
### ধাপ ২. Starship ব্যবহার করার জন্য আপনার শেল প্রস্তুত করুন
Starship চালু করতে আপনার শেল কে ঠিক মতো কনফিগার করুন । নিম্নলিখিত তালিকা থেকে আপনার শেল বাছাই করুন:
<details>
<summary>Bash</summary>
`~/.bashrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
eval "$(starship init bash)"
```
</details>
<details>
<summary>Cmd</summary>
আপনাকে Cmd এর সাথে [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) ব্যবহার করতে হবে । `%LocalAppData%\clink\starship.lua` ফাইল টি তৈরি করে তার মধ্যে নিম্নলিখিত লাইন টি যোগ করুন:
```lua
load(io.popen('starship init cmd'):read("*a"))()
```
</details>
<details>
<summary>Elvish</summary>
`~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
eval (starship init elvish)
```
বিঃদ্রঃ শুধুমাত্র Elvish v0.18+ কাজ করবে ।
</details>
<details>
<summary>Fish</summary>
`~/.config/fish/config.fish` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```fish
starship init fish | source
```
</details>
<details>
<summary>Ion</summary>
`~/.config/ion/initrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
eval $(starship init ion)
```
</details>
<details>
<summary>Nushell</summary>
আপনার Nushell env ফাইলের (Nushell এ `$nu.env-path` কমান্ডটি রান করে ফাইলটি খুঁজে বের করুন) শেষে নিম্নলিখিত লাইনগুলি যোগ করুন:
```sh
mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu
```
এরপর আপনার Nushell কনফিগের (Nushell এ `$nu.config-path` কমান্ডটি রান করে ফাইলটি খুঁজে বের করুন) শেষে নিম্নলিখিত লাইনটি যোগ করুন:
```sh
use ~/.cache/starship/init.nu
```
বিঃদ্রঃ শুধুমাত্র Nushell v0.78+ কাজ করবে ।
</details>
<details>
<summary>PowerShell</summary>
আপনার PowerShell কনফিগের (PowerShell এ `$PROFILE` কমান্ডটি রান করে ফাইলটি খুঁজে বের করুন) শেষে নিম্নলিখিত লাইনটি যোগ করুন:
```powershell
Invoke-Expression (&starship init powershell)
```
</details>
<details>
<summary>Tcsh</summary>
`~/.tcshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
eval `starship init tcsh`
```
</details>
<details>
<summary>Xonsh</summary>
`~/.xonshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```python
execx($(starship init xonsh))
```
</details>
<details>
<summary>Zsh</summary>
`~/.zshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
```sh
eval "$(starship init zsh)"
```
</details>
### ধাপ ৩. Starship কনফিগার করুন
নতুন একটি শেল চালু করুন, এরপর আপনি আপনার সুন্দর নতুন শেল প্রম্প্ট দেখতে পাবেন । পূর্ব নির্ধারিত কনফিগ যদি ভালো লেগে থাকে, তাহলে উপভোগ করুন!
আপনি যদি Starship কে নিজের মতো করে কাস্টমাইজ করতে চান:
- **[কনফিগারেশন](https://starship.rs/config/)** – আপনার নিজের ইচ্ছা মতো নিজের প্রম্প্টকে পরিবর্তন করতে শিখুন
- **[অন্যদের তৈরি কনফিগ](https://starship.rs/presets/)** – অন্যদের তৈরি করা সুন্দর কনফিগ দেখে অনুপ্রাণিত হন
## 🤝 নিজে অবদান রাখুন
আমরা সবসময় **সকল দক্ষতা স্তরের** অবদানকারীদের খুঁজছি! আপনি যদি সহজ ভাবে এই প্রোজেক্টে অবদান রাখতে চান তাইলে ["good first issue"](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) গুলির সমাধান করার চেষ্টা করতে পারেন ।
আপনি যদি ইংরেজি ছাড়া অন্য কোন ভাষায় সাবলীল হন, তাহলে আপনি আমাদের ডকুমেন্টেশন অনুবাদে এবং আপ-টু-ডেট রাখতে সহায়তা করতে পারেন, আমরা খুবই কৃতজ্ঞ হব । যদি এক্ষেত্রে সাহায্য করতে চান, তাহলে [Starship Crowdin](https://translate.starship.rs/) পেইজ এ গিয়ে আপনার অনুবাদ গুলি যোগ করতে পারবেন ।
আপনি যদি Starship এ অবদান রাখতে আগ্রহী হন, অনুগ্রহ করে আমাদের অবদান রাখার [নির্দেশিকা ও নিয়মকানুন](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) দেখে নিবেন । এছাড়াও, নির্দ্বিধায় আমাদের [Discord](https://discord.gg/8Jzqu3T) সার্ভারে এসে হাই বলে যান । 👋
## 💭 অনুপ্রেরণা
অনুগ্রহ করে Starship এর পূর্ববর্তী এইসব প্রোজেক্ট থেকে ঘুরে আসুন, যারা Starship তৈরিতে অনেক অনুপ্রেরণা দিয়েছে । 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts.
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – Cross-shell robbyrussell theme written in JavaScript.
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
## ❤️ স্পনসর
[একজন স্পনসর হয়ে](https://github.com/sponsors/starship) এই প্রোজেক্টটিকে আর্থিক ভাবে সহায়তা করুন । আপনার নাম অথবা লোগো নিম্নে দেখা যাবে আপনার ওয়েবসাইট এর লিঙ্ক সহ ।
**সমর্থক স্তর**
- [Appwrite](https://appwrite.io/)
<p align="center">
<br>
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
</p>
## 📝 লাইসেন্স
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> এই প্রোজেক্টটি [ISC](https://github.com/starship/starship/blob/master/LICENSE) লাইসেন্সের অধিনে রয়েছে ।

93
docs/bn-BD/installing/README.md Normal file
View File

@ -0,0 +1,93 @@
# Advanced Installation
To install starship, you need to do two things:
1. Get the **starship** binary onto your computer
1. Tell your shell to use the starship binary as its prompt by modifying its init scripts
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [Chocolatey](https://chocolatey.org)
### পূর্বশর্ত
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### ইন্সটল
```powershell
choco install starship
```
## [termux](https://termux.com)
### পূর্বশর্ত
```sh
pkg install getconf
```
### ইন্সটল
```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin
```
## [Funtoo Linux](https://www.funtoo.org/Welcome)
### ইন্সটল
On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage:
```sh
emerge app-shells/starship
```
## [Nix](https://nixos.wiki/wiki/Nix)
### Getting the Binary
#### Imperatively
```sh
nix-env -iA nixos.starship
```
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
Enable the `programs.starship` module in your `home.nix` file, and add your settings
```nix
{
programs.starship = {
enable = true;
# Configuration written to ~/.config/starship.toml
settings = {
# add_newline = false;
# character = {
# success_symbol = "[➜](bold green)";
# error_symbol = "[➜](bold red)";
# };
# package.disabled = true;
};
};
}
```
then run
```sh
home-manager switch
```
#### Declarative, system-wide, with NixOS
Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run
```sh
sudo nixos-rebuild switch
```

267
docs/bn-BD/migrating-to-0.45.0/README.md Normal file
View File

@ -0,0 +1,267 @@
# Migrating to v0.45.0
Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization.
This guide is intended to walk you through the breaking changes.
## `prompt_order` has been replaced by a root-level `format`
Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship.
Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves.
**Example pre-v0.45.0 configuration**
```toml
prompt_order = [
"username",
"hostname",
"directory",
"git_branch",
"git_commit",
"git_state",
"git_status",
"cmd_duration",
"custom",
"line_break",
"jobs",
"battery",
"time",
"character",
]
```
**Example v0.45.0 configuration**
```toml
format = """\
$username\
$hostname\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$cmd_duration\
$custom\
$line_break\
$jobs\
$battery\
$time\
$character\
"""
```
## Module `prefix` and `suffix` have been replaced by `format`
Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered.
Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output.
**Example pre-v0.45.0 configuration**
```toml
[cmd_duration]
prefix = "took "
```
**Example v0.45.0 configuration**
```toml
[cmd_duration]
# $duration – The command duration (e.g. "15s")
# $style – The default style of the module (e.g. "bold yellow")
format = "took [$duration]($style) "
```
### Affected Modules
#### Character
| Removed Property | Replacement |
| ----------------------- | ---------------- |
| `symbol` | `success_symbol` |
| `use_symbol_for_status` | `error_symbol` |
| `style_success` | `success_symbol` |
| `style_failure` | `error_symbol` |
**Changes to the Default Configuration**
```diff
[character]
-- symbol = "❯"
-- error_symbol = "✖"
-- use_symbol_for_status = true
-- vicmd_symbol = "❮"
++ success_symbol = "[❯](bold green)"
++ error_symbol = "[❯](bold red)"
++ vicmd_symbol = "[❮](bold green)"
```
Previously, the `use_symbol_for_status` property was used to configure the prompt to show the `error_symbol` when the last command resulted in a non-zero status code.
With the release of v0.45.0, we now always use `error_symbol` after non-zero status codes, unifying `use_symbol_for_status` and `error_symbol` properties.
To configure the prompt to use the older `use_symbol_for_status = true` configuration, add the following to your config file:
```toml
[character]
error_symbol = "[✖](bold red)"
```
_Note:_ The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples.
#### Command Duration
| Removed Property | Replacement |
| ---------------- | ----------- |
| `prefix` | `format` |
**Changes to the Default Configuration**
```diff
[cmd_duration]
-- prefix = "took "
++ format = "took [$duration]($style) "
```
#### Directory
| Removed Property | Replacement |
| ---------------- | ----------- |
| `prefix` | `format` |
**Changes to the Default Configuration**
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$read_only]($read_only_style) "
```
#### Environment Variable
| Removed Property | Replacement |
| ---------------- | ----------- |
| `prefix` | `format` |
| `suffix` | `format` |
**Changes to the Default Configuration**
```diff
[env_var]
-- prefix = ""
-- suffix = ""
++ format = "with [$env_value]($style) "
```
#### Git Commit
| Removed Property | Replacement |
| ---------------- | ----------- |
| `prefix` | `format` |
| `suffix` | `format` |
**Changes to the Default Configuration**
```diff
[git_commit]
-- prefix = "("
-- suffix = ")"
++ format = '[\($hash\)]($style) '
```
#### Git Status
| Removed Property | Replacement |
| ----------------- | ----------- |
| `prefix` | `format` |
| `suffix` | `format` |
| `show_sync_count` | `format` |
**Changes to the Default Configuration**
```diff
[git_status]
-- prefix = "["
-- suffix = "]"
-- show_sync_count = false
++ format = '([\[$all_status$ahead_behind\]]($style) )'
```
Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch.
With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`.
To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file:
```toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
#### Hostname
| Removed Property | Replacement |
| ---------------- | ----------- |
| `prefix` | `format` |
| `suffix` | `format` |
**Changes to the Default Configuration**
```diff
[hostname]
-- prefix = ""
-- suffix = ""
++ format = "[$hostname]($style) in "
```
#### Singularity
| Removed Property | Replacement |
| ---------------- | ----------- |
| `label` | `format` |
| `prefix` | `format` |
| `suffix` | `format` |
**Changes to the Default Configuration**
```diff
[singularity]
-- prefix = ""
-- suffix = ""
++ format = '[$symbol\[$env\]]($style) '
```
#### Time
| Removed Property | Replacement |
| ---------------- | ------------- |
| `format` | `time_format` |
**Changes to the Default Configuration**
```diff
[time]
-- format = "🕙[ %T ]"
++ time_format = "%T"
++ format = "at 🕙[$time]($style) "
```
#### Custom Commands
| Removed Property | Replacement |
| ---------------- | ----------- |
| `prefix` | `format` |
| `suffix` | `format` |
**Changes to the Default Configuration**
```diff
[custom.example]
-- prefix = ""
-- suffix = ""
++ format = "[$symbol$output]($style) "
```

71
docs/bn-BD/presets/README.md Normal file
View File

@ -0,0 +1,71 @@
# Presets
Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
To get details on how to use a preset, simply click on the image.
## [Nerd Font Symbols](./nerd-font.md)
This preset changes the symbols for each module to use Nerd Font symbols.
[![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font)
## [No Nerd Fonts](./no-nerd-font.md)
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
::: tip
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
:::
[Click to view No Nerd Font preset](./no-nerd-font)
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
[![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments)
## [Plain Text Symbols](./plain-text.md)
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
[![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text)
## [No Runtime Versions](./no-runtimes.md)
This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you!
[![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes)
## [No Empty Icons](./no-empty-icons.md)
This preset does not show icons if the toolset is not found.
[![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png "Click to view No Runtime Versions preset")](./no-empty-icons.md)
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
[![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset)
## [Pastel Powerline](./pastel-powerline.md)
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline)
## [Tokyo Night](./tokyo-night.md)
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

17
docs/bn-BD/presets/bracketed-segments.md Normal file
View File

@ -0,0 +1,17 @@
[Return to Presets](./README.md#bracketed-segments)
# Bracketed Segments Preset
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png)
### Configuration
```sh
starship preset bracketed-segments -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml

21
docs/bn-BD/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### পূর্বশর্ত
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
### Configuration
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/bn-BD/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Return to Presets](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Configuration
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

21
docs/bn-BD/presets/nerd-font.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#nerd-font-symbols)
# Nerd Font Symbols Preset
This preset changes the symbols for each module to use Nerd Font symbols.
![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png)
### পূর্বশর্ত
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)
### Configuration
```sh
starship preset nerd-font-symbols -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/nerd-font-symbols.toml)
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml

17
docs/bn-BD/presets/no-empty-icons.md Normal file
View File

@ -0,0 +1,17 @@
[Return to Presets](./README.md#no-empty-icons)
# No Empty Icons Preset
If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png)
### Configuration
```sh
starship preset no-empty-icons -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/no-empty-icons.toml)
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml

19
docs/bn-BD/presets/no-nerd-font.md Normal file
View File

@ -0,0 +1,19 @@
[Return to Presets](./README.md#no-nerd-fonts)
# No Nerd Fonts Preset
This preset restricts the use of symbols to those from emoji and powerline sets.
This means that even without a Nerd Font installed, you should be able to view all module symbols.
This preset will become the default preset in a future release of starship.
### Configuration
```sh
starship preset no-nerd-font -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/no-nerd-font.toml)
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml

17
docs/bn-BD/presets/no-runtimes.md Normal file
View File

@ -0,0 +1,17 @@
[Return to Presets](./README.md#no-runtime-versions)
# No Runtime Versions Preset
This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you!
![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png)
### Configuration
```sh
starship preset no-runtime-versions -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/no-runtime-versions.toml)
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml

21
docs/bn-BD/presets/pastel-powerline.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#pastel-powerline)
# Pastel Powerline Preset
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png)
### পূর্বশর্ত
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font)
### Configuration
```sh
starship preset pastel-powerline -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml

17
docs/bn-BD/presets/plain-text.md Normal file
View File

@ -0,0 +1,17 @@
[Return to Presets](./README.md#plain-text-symbols)
## Plain Text Symbols Preset
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png)
### Configuration
```sh
starship preset plain-text-symbols -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/plain-text-symbols.toml)
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml

17
docs/bn-BD/presets/pure-preset.md Normal file
View File

@ -0,0 +1,17 @@
[Return to Presets](./README.md#pure)
# Pure Preset
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
![Screenshot of Pure preset](/presets/img/pure-preset.png)
### Configuration
```sh
starship preset pure-preset -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml

21
docs/bn-BD/presets/tokyo-night.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#pastel-powerline)
# Tokyo Night Preset
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png)
### পূর্বশর্ত
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
### Configuration
```sh
starship preset tokyo-night -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/tokyo-night.toml)
<<< @/.vuepress/public/presets/toml/tokyo-night.toml

279
docs/ckb-IR/config/README.md
View File

@ -206,6 +206,13 @@ This is the list of prompt-wide configuration options.
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $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 [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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | The style for the module. | | `style` | `'bold yellow'` | The style for the module. |
| `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` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | | `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders 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 | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | The style for the module. | | `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -671,7 +683,7 @@ The character will tell you whether the last command was successful or not. It c
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). 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). `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).
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Options
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. |
| `symbol` | `'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. |
| `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. |
### 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. |
| symbol | | 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
### نموونە
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `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_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Options
| 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. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| گۆڕاو | نموونە | 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
### نموونە
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Options ### Options
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | The format for the module. | | `format` | `'via [$symbol]($style) '` | The format for the module. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | | `detect_folders` | `['gradle']` | Which folders should trigger this module. |
| `style` | `"bold bright-cyan"` | The style for the module. | | `style` | `'bold bright-cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `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_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_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. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | The style for the module. | | `style` | `'bold fg:202'` | The style for the module. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `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. | | `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 | | `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. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | The style for the module. | | `style` | `'bold dimmed green'` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2126,7 +2215,9 @@ The `hostname` module shows the system hostname.
*: 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
### نموونە ### Examples
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## 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:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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 ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Options ### Options
::: ئاگادارکردنەوە
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 |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `'cyan bold'` | The style for the module. | | `style` | `'cyan bold'` | The style for the module. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `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:
| گۆڕاو | 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. |
| `symbol` | 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)).
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## 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. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `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 ### Variables
@ -2890,8 +3021,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | The format for the module. | | `format` | `'[$symbol]($style)'` | The format for the module. |
| `style` | `"bold white"` | The style for the module. | | `style` | `'bold white'` | The style for the module. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `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:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `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_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_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
@ -3563,11 +3694,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `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` | | `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. | | `detect_extensions` | `['sol']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- The current directory contains a `template.typ` file
- The current directory contains any `*.typ` file
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `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 `daml` module. |
### Variables
| گۆڕاو | نموونە | Description |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
## Username ## 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:

8
docs/ckb-IR/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="شوێن @StarshipPrompt بکەوە لەسەر تویتەر" alt="شوێن @StarshipPrompt بکەوە لەسەر تویتەر"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -143,8 +148,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -225,6 +228,7 @@ Alternatively, install Starship using any of the following package managers:
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

6
docs/ckb-IR/presets/README.md
View File

@ -63,3 +63,9 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/ckb-IR/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### پێشمەرجەکان
- [فۆنتێکی Nerd](https://www.nerdfonts.com/) دامەزراوە و چالاککراوە لە تێرمیناڵەکەتا
### ڕێکخستن
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/ckb-IR/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Return to Presets](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### ڕێکخستن
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

277
docs/de-DE/config/README.md
View File

@ -206,6 +206,13 @@ Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen.
| `add_newline` | `true` | Fügt leere Zeilen zwischen Shell Prompts ein. | | `add_newline` | `true` | Fügt leere Zeilen zwischen Shell Prompts ein. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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`.
:::
### Beispiel ### Beispiel
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $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 [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.
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Tabelle der Regionaliasen, die zusätzlich zum AWS-Namen angezeigt werden sollen. | | `region_aliases` | `{}` | Tabelle der Regionaliasen, die zusätzlich zum AWS-Namen angezeigt werden sollen. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | Stil für dieses Modul. | | `style` | `'bold yellow'` | Stil für dieses Modul. |
| `expiration_symbol` | `X` | Das Symbol, das angezeigt wird, wenn die temporären Anmeldeinformationen abgelaufen sind. | | `expiration_symbol` | `'X'` | Das Symbol, das angezeigt wird, wenn die temporären Anmeldeinformationen abgelaufen sind. |
| `disabled` | `false` | Deaktiviert das `aws`-Modul. | | `disabled` | `false` | Deaktiviert das `aws`-Modul. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | | `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders 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 | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | Stil für dieses Modul. | | `style` | `'bold 149'` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Optionen
| Option | Standartwert | Beschreibung |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | Das Format für das Modul. |
| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |
| `style` | `'bold orange'` | Stil für dieses Modul. |
| `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. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | ------------------- | --------------------------------------- |
| 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 | | Spiegelt den Wert der Option `symbol`. |
| style\* | `red bold` | Spiegelt den Wert der Option `style`. |
*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Stil für dieses Modul. | | `style` | `'bold green'` | Stil für dieses Modul. |
| `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_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Optionen
| Option | Standartwert | Beschreibung |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Das Format für das Modul. |
| `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. |
### Variables
| Variable | Beispiel | Beschreibung |
| ----------------- | -------- | ------------------------------------------- |
| 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
### Beispiel
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Optionen ### Optionen
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | Das Format für das Modul. | | `format` | `'via [$symbol]($style) '` | Das Format für das Modul. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | Stil für dieses Modul. | | `style` | `'yellow bold'` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | | `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | | `detect_folders` | `['gradle']` | Which folders should trigger this module. |
| `style` | `"bold bright-cyan"` | Stil für dieses Modul. | | `style` | `'bold bright-cyan'` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | | `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `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_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_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. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | Stil für dieses Modul. | | `style` | `'bold fg:202'` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ Das `hostname`-Modul zeigt den Hostnamen des Systems an.
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. | | `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to 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 | | `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 '` | Das Format für das Modul. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | Das Format für das Modul. |
| `style` | `'bold dimmed green'` | Stil für dieses Modul. | | `style` | `'bold dimmed green'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `hostname`-Modul. | | `disabled` | `false` | Deaktiviert das `hostname`-Modul. |
@ -2126,7 +2215,9 @@ Das `hostname`-Modul zeigt den Hostnamen des Systems an.
*: 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
### Beispiel ### Beispiele
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## 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:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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 ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Optionen ### Optionen
::: warning
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Das Format für das Modul. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Das Format für das Modul. |
| `style` | `'cyan bold'` | Stil für dieses Modul. | | `style` | `'cyan bold'` | Stil für dieses Modul. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Deaktiviert das `kubernetes`-Modul. | | `disabled` | `true` | Deaktiviert das `kubernetes`-Modul. |
*: 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:
| Variable | Beschreibung |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `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. |
| `symbol` | 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)).
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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"
``` ```
## Zeilenumbruch ## Zeilenumbruch
@ -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. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | Stil für dieses Modul. | | `style` | `'bold green'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `nodejs`-Modul. | | `disabled` | `false` | Deaktiviert das `nodejs`-Modul. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | | `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 ### Variables
@ -2890,8 +3021,8 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | Das Format für das Modul. | | `format` | `'[$symbol]($style)'` | Das Format für das Modul. |
| `style` | `"bold white"` | Stil für dieses Modul. | | `style` | `'bold white'` | Stil für dieses Modul. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `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:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | Stil für dieses Modul. | | `style` | `'yellow bold'` | Stil für dieses Modul. |
| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | | `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `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_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_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
@ -3563,11 +3694,12 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | | `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. | | `detect_extensions` | `['sol']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | Stil für dieses Modul. | | `style` | `'bold blue'` | Stil für dieses Modul. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `template.typ`-Datei
- The current directory contains any `*.typ` file
### Optionen
| Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `style` | `'bold #0093A7'` | Stil für dieses Modul. |
| `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 `daml` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Spiegelt den Wert der Option `symbol` |
| style\* | | Spiegelt den Wert der Option `style` |
*: This variable can only be used as a part of a style string
## Username ## Username
Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:

10
docs/de-DE/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Folge @StarshipPrompt auf Twitter" alt="Folge @StarshipPrompt auf Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -158,7 +161,7 @@
align="right" align="right"
/> />
**Der minimalistische, super schnelle und unendlich anpassbare Prompt für jede Shell!** **Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!**
- **Schnell:** sie ist schnell – _sehr, sehr_ schnell! 🚀 - **Schnell:** sie ist schnell – _sehr, sehr_ schnell! 🚀
- **Konfigurierbar:** konfiguriere jedes Detail der Prompt. - **Konfigurierbar:** konfiguriere jedes Detail der Prompt.
@ -229,6 +232,7 @@ Alternatively, install Starship using any of the following package managers:
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

6
docs/de-DE/presets/README.md
View File

@ -63,3 +63,9 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/de-DE/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Zurück zu den Voreinstellungen](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### Voraussetzungen
- Eine [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in deinem Terminal
### Konfiguration
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Zum Herunterladen der TOML Datei klicken](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/de-DE/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Zurück zu den Voreinstellungen](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Konfiguration
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Zum Herunterladen der TOML Datei klicken](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

347
docs/es-ES/config/README.md
View File

@ -78,7 +78,7 @@ In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared wit
The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
| Symbol | Tipo | Notas | | Simbol | Tipo | Notas |
| ------ | ------------------------- | ------------------------------------------------------ | | ------ | ------------------------- | ------------------------------------------------------ |
| `'` | literal string | less escaping | | `'` | literal string | less escaping |
| `"` | string | more escaping | | `"` | string | more escaping |
@ -152,15 +152,15 @@ En la segunda parte, que está encerrada entre `()`, es una [cadena de estilo](#
Por ejemplo: Por ejemplo:
- `'[on](red bold)'` will print a string `on` with bold text colored red. - `'[on](red bold)'` imprimirá el texto `on` con color rojo y en negrita.
- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `'[⌘ $version](bold green)'` imprimirá el símbolo `⌘` seguido por el contenido de la variable `version` con color verde en negrita.
- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green. - `'[a [b](red) c](green)'` imprimirá `a b c` donde `b` es rojo, pero `a` y `c` son verde.
#### Cadenas de Estilo #### Cadenas de Estilo
La mayoría de los módulos de starship permiten configurar sus estilos de visualización. Esto se consigue con una entrada (normalmente llamada `style`) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de cadenas de estilo junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consultar [la guía de configuración avanzada](/advanced-config/). La mayoría de los módulos de starship permiten configurar sus estilos de visualización. Esto se consigue con una entrada (normalmente llamada `style`) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de cadenas de estilo junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consultar [la guía de configuración avanzada](/advanced-config/).
- `'fg:green bg:blue'` sets green text on a blue background - `'fg:green bg:blue'` define el texto con color verde y el color de fondo azul
- `'bg:blue fg:bright-green'` sets bright green text on a blue background - `'bg:blue fg:bright-green'` sets bright green text on a blue background
- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27 - `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
- `'underline bg:#bf5700'` sets underlined text on a burnt orange background - `'underline bg:#bf5700'` sets underlined text on a burnt orange background
@ -206,6 +206,13 @@ Esta es la lista de opciones de configuración del prompt.
| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. | | `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. |
| `paleta` | `''` | Establece la paleta de color de `paletas` a utilizar. | | `paleta` | `''` | Establece la paleta de color de `paletas` a utilizar. |
| `paletas` | `{}` | Colección de paletas de colores que asignan [colores](/advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. | | `paletas` | `{}` | Colección de paletas de colores que asignan [colores](/advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. |
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip
If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
:::
### Ejemplo ### Ejemplo
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $custom\
@ -345,12 +355,14 @@ The module will display a profile only if its credentials are present in `~/.aws
Cuando se utiliza [aws-vault](https://github.com/99designs/aws-vault), el perfil se obtiene de la variable de entorno `AWS_VAULT` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWS_SESSION_EXPIRATION`. Cuando se utiliza [aws-vault](https://github.com/99designs/aws-vault), el perfil se obtiene de la variable de entorno `AWS_VAULT` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWS_SESSION_EXPIRATION`.
Cuando se utiliza [awsu](https://github.com/kreuzwerker/awsu) el perfil se lee de la variable de entorno `AWSU_PROFILE`. Cuando uses [awsu](https://github.com/kreuzwerker/awsu) el perfil se obtiene de la variable de entorno `AWSU_PROFILE`.
Cuando se utiliza [AWSume](https://awsu.me), el perfil se obtiene de la variable de entorno `AWSUME_PROFILE` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWSUME_EXPIRATION`. Cuando se utiliza [AWSume](https://awsu.me), el perfil se obtiene de la variable de entorno `AWSUME_PROFILE` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWSUME_EXPIRATION`.
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 [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.
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Tabla de alias de región para mostrar además del nombre AWS. | | `region_aliases` | `{}` | Tabla de alias de región para mostrar además del nombre AWS. |
| `profile_aliases` | `{}` | Tabla de alias de región para mostrar además del nombre AWS. | | `profile_aliases` | `{}` | Tabla de alias de región para mostrar además del nombre AWS. |
| `style` | `'bold yellow'` | El estilo del módulo. | | `style` | `'bold yellow'` | El estilo del módulo. |
| `expiration_symbol` | `X` | El símbolo mostrado cuando las credenciales temporales han caducado. | | `expiration_symbol` | `'X'` | El símbolo mostrado cuando las credenciales temporales han caducado. |
| `disabled` | `false` | Desactiva el módulo AWS. | | `disabled` | `false` | Desactiva el módulo AWS. |
| `force_display` | `false` | Si `true` muestra información incluso si `credentials`, `credential_process` o `sso_start_url` no han sido configuradas. | | `force_display` | `false` | Si `true` muestra información incluso si `credentials`, `credential_process` o `sso_start_url` no han sido configuradas. |
@ -472,7 +484,7 @@ very-long-subscription-name = 'vlsn'
## Battery ## Battery
El módulo `battery` muestra la cantidad de batería y si se está cargando o no. El módulo solamente es visible cuando la batería del dispositivo está por debajo del 10%. El módulo `battery` muestra qué tan cargada está la batería del dispositivo y su estado de carga actual. El módulo solamente es visible cuando la batería del dispositivo está por debajo del 10%.
### Opciones ### Opciones
@ -621,14 +633,14 @@ El módulo `c` muestra información sobre su compilador de C. Por defecto el mó
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | La cadena de formato para el módulo. | | `format` | `'via [$symbol($version(-$name) )]($style)'` | La cadena de formato para el módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | El símbolo usado antes de mostrar los detalles del compilador | | `symbol` | `'C '` | El símbolo usado antes de mostrar los detalles del compilador |
| `detect_extensions` | `['c', 'h']` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `['c', 'h']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | Cómo detectar cuál compilador es | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | Cómo detectar cuál compilador es |
| `style` | `'bold 149'` | El estilo del módulo. | | `style` | `'bold 149'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `c`. | | `disabled` | `false` | Deshabilita el módulo `c`. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | El formato del módulo. |
| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |
| `style` | `'bold orange'` | El estilo del módulo. |
| `disabled` | `true` | Disables the `direnv` module. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['.envrc']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `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. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------------------- | --------------------------------------- |
| 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 | | Refleja el valor de la opción `symbol`. |
| style\* | `red bold` | Refleja el valor de la opción `style`. |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Contexto de Docker ## Contexto de Docker
El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está definido en `default` o si las variables de entorno `DOCKER_MACHINE_NAME`, `DOCKER_HOST` o `DOCKER_CONTEXT` están definidas (como se entiende para sobrescribir el contexto en uso). El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está definido en `default` o si las variables de entorno `DOCKER_MACHINE_NAME`, `DOCKER_HOST` o `DOCKER_CONTEXT` están definidas (como se entiende para sobrescribir el contexto en uso).
@ -1435,7 +1488,7 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | El estilo del módulo. | | `style` | `'bold green'` | El estilo del módulo. |
| `detect_extensions` | `[fnl]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `['fnl']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Opciones
| Opción | Predeterminado | Descripción |
| -------------------- | ------------------------------------------------------------ | -------------------------------------------------- |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | El formato del módulo. |
| `added_style` | `'bold green'` | El estilo para el recuento añadido. |
| `deleted_style` | `'bold red'` | El estilo para el recuento eliminado. |
| `only_nonzero_diffs` | `true` | Mostrar sólo el estado de los elementos cambiados. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| Variable | Ejemplo | Descripción |
| ----------------- | ------- | --------------------------------------------- |
| añadido | `1` | El número actual de líneas añadidas |
| eliminado | `2` | El número actual de líneas eliminadas |
| added_style\* | | Refleja el valor de la opción `added_style` |
| deleted_style\* | | Refleja el valor de la opción `deleted_style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](https://cloud.google.com/sdk/gcloud). Esto se basa en el archivo `~/.config/gcloud/active_config`, el archivo `~/.config/gcloud/configurations/config_{CONFIG NAME}` y la variable de entorno `CLOUDSDK_CONFIG`. El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](https://cloud.google.com/sdk/gcloud). Esto se basa en el archivo `~/.config/gcloud/active_config`, el archivo `~/.config/gcloud/configurations/config_{CONFIG NAME}` y la variable de entorno `CLOUDSDK_CONFIG`.
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.
### Opciones ### Opciones
@ -1548,7 +1636,7 @@ When the module is enabled it will always be active, unless `detect_env_vars` ha
| --------- | ------------- | ----------------------------------------------------------------------------- | | --------- | ------------- | ----------------------------------------------------------------------------- |
| region | `us-central1` | La actual región GCP | | region | `us-central1` | La actual región GCP |
| cuenta | `foo` | El perfil actual de GCP | | cuenta | `foo` | El perfil actual de GCP |
| dominio | `ejemplo.com` | El dominio actual del perfil GCP | | dominio | `example.com` | El dominio actual del perfil GCP |
| proyecto | | El proyecto GCP actual | | proyecto | | El proyecto GCP actual |
| activo | `default` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` | | activo | `default` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
@ -1745,7 +1833,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| ----------------- | ------- | --------------------------------------------- | | ----------------- | ------- | --------------------------------------------- |
| añadido | `1` | El número actual de líneas añadidas | | añadido | `1` | El número actual de líneas añadidas |
| borrado | `2` | El número actual de líneas eliminadas | | eliminado | `2` | El número actual de líneas eliminadas |
| added_style\* | | Refleja el valor de la opción `added_style` | | added_style\* | | Refleja el valor de la opción `added_style` |
| deleted_style\* | | Refleja el valor de la opción `deleted_style` | | deleted_style\* | | Refleja el valor de la opción `deleted_style` |
@ -1786,7 +1874,7 @@ El módulo Git Status es muy lento en los directorios de Windows (por ejemplo ba
| `modificado` | `'!'` | El formato de `modified` | | `modificado` | `'!'` | El formato de `modified` |
| `staged` | `'+'` | El formato de `staged` | | `staged` | `'+'` | El formato de `staged` |
| `renamed` | `'»'` | El formato de `renamed` | | `renamed` | `'»'` | El formato de `renamed` |
| `borrado` | `'✘'` | El formato de `deleted` | | `eliminado` | `'✘'` | El formato de `deleted` |
| `typechanged` | `""` | The format of `typechange` | | `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | El estilo del módulo. | | `style` | `'bold red'` | El estilo del módulo. |
| `ignore_submodules` | `false` | Ignorar cambios a los submódulos. | | `ignore_submodules` | `false` | Ignorar cambios a los submódulos. |
@ -1807,7 +1895,7 @@ Las siguientes variables se pueden utilizar en `format`:
| `modificado` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. | | `modificado` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. |
| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de preparación. | | `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de preparación. |
| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de preparación. | | `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de preparación. |
| `borrado` | Muestra `deleted` cuando un archivo ha sido añadido al área de preparación. | | `eliminado` | Muestra `deleted` cuando un archivo ha sido añadido al área de preparación. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. | | `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Refleja el valor de la opción `style` | | style\* | Refleja el valor de la opción `style` |
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'vía [$symbol]($style) '` | El formato del módulo. | | `format` | `'vía [$symbol]($style) '` | El formato del módulo. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | El estilo del módulo. | | `style` | `'yellow bold'` | El estilo del módulo. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `["gradle"]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `['gradle']` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold bright-cyan"` | El estilo del módulo. | | `style` | `'bold bright-cyan'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `gradle`. | | `disabled` | `false` | Deshabilita el módulo `gradle`. |
| `recursivo` | `false` | Enables recursive finding for the `gradle` directory. | | `recursivo` | `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
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["hx", "hxml"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `['hx', 'hxml']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Qué carpetas deberían activar estos módulos. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `"⌘ "` | Una cadena de formato que representa el símbolo de Helm. | | `symbol` | `'⌘ '` | Una cadena de formato que representa el símbolo de Helm. |
| `style` | `"bold fg:202"` | El estilo del módulo. | | `style` | `'bold fg:202'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `haxe`. | | `disabled` | `false` | Deshabilita el módulo `haxe`. |
### Variables ### Variables
@ -2108,25 +2196,40 @@ El módulo `hostname` muestra el nombre de host del sistema.
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. | | `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. |
| `ssh_symbol` | `'🌐 '` | Una cadena de formato que representa el símbolo cuando se conecta a la sesión SSH. | | `ssh_symbol` | `'🌐 '` | Una cadena de formato que representa el símbolo cuando se conecta a la sesión SSH. |
| `trim_at` | `'.'` | Cadena en la que el nombre del host se corta, después de la primera coincidencia. `'.'` will stop after the first dot. `''` will disable any truncation | | `trim_at` | `'.'` | Cadena en la que el nombre del host se corta, después de la primera coincidencia. `'.'` will stop after the first dot. `''` deshabilitará cualquier truncamiento. |
| `detect_env_vars` | `[]` | Qué variable(s) de entorno deben activar este módulo. |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | El formato del módulo. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | El formato del módulo. |
| `style` | `'negrita oscurecida verde'` | El estilo del módulo. | | `style` | `'negrita oscurecida verde'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `hostname`. | | `disabled` | `false` | Deshabilita el módulo `hostname<0>.</td>
</tr>
</tbody>
</table>
### Variables <h3 spaces-before="0">Variables</h3>
| Variable | Ejemplo | Descripción | <table spaces-before="0">
| --------------- | ------------- | -------------------------------------------------------------- | <thead>
| nombre del host | `computadora` | El nombre de host de la computadora | <tr>
<th>Variable</th>
<th>Ejemplo</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td>nombre del host</td>
<td><code>computadora` | El nombre de host de la computadora |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
| ssh_symbol | `'🌏 '` | El símbolo a representar cuando está conectado a la sesión SSH | | ssh_symbol | `'🌏 '` | El símbolo a representar cuando está conectado a la sesión SSH |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
### Ejemplo ### Ejemplos
#### Mostrar siempre el nombre del host
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2241,17 @@ trim_at = '.companyname.com'
disabled = false disabled = false
``` ```
#### Ocultar el nombre de host en sesiones remotas de tmux
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
disabled = false
```
## Java ## Java
El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com/java/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com/java/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
@ -2317,13 +2431,13 @@ symbol = '🅺 '
# ~/.config/starship.toml # ~/.config/starship.toml
[kotlin] [kotlin]
# Uses the Kotlin Compiler binary to get the installed version # Utiliza el compilador binario Kotlink para obtener la versión instalada
kotlin_binary = 'kotlinc' kotlin_binary = 'kotlinc'
``` ```
## Kubernetes ## Kubernetes
Muestra el nombre actual del [contexto de Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) y, si se establece, el espacio de nombres, el usuario y el clúster del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-context --namespace astronaut`. Del mismo modo, el usuario y clúster pueden establecerse con `kubectl config set-context starship-context --user starship-user` y `kubectl config set-context starship-context --cluster starship-cluster`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`. Muestra el nombre actual del [contexto de Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) y, si se establece, el espacio de nombres, el usuario y el clúster del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`.
::: tip ::: tip
@ -2335,18 +2449,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Opciones ### Opciones
::: warning
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- |
| `symbol` | `'☸ '` | Una cadena de formato que representa el símbolo mostrado antes del Cluster. | | `symbol` | `'☸ '` | Una cadena de formato que representa el símbolo mostrado antes del Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. |
| `style` | `'cyan bold'` | El estilo del módulo. | | `style` | `'cyan bold'` | El estilo del módulo. |
| `context_aliases` | `{}` | Tabla de alias de contexto a mostrar. | | `context_aliases`* | `{}` | Tabla de alias de contexto a mostrar. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `contextos` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Desactiva el módulo `kubernetes`. | | `disabled` | `true` | Desactiva el módulo `kubernetes`. |
*: 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:
| Variable | Descripción |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `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. |
| `symbol` | 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)).
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
@ -2368,13 +2504,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2519,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Busqueda por Regex #### Configuración específica del Contexto de Kubernetes
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
La expresión regular debe coincidir en todo el contexto de kube. los grupos de captura pueden ser referenciados usando `$name` y `$N` en el reemplazo. Esto está más explicado en la documentación del [crate regex](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace).
Los nombres de cluster generados de forma larga y automática pueden ser identificados y abreviados usando expresiones regulares:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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"
``` ```
## Salto de línea ## Salto de línea
@ -2730,7 +2873,7 @@ El módulo `nodejs` muestra la versión instalada de [Node.js](https://nodejs.or
| `detect_folders` | `['node_modules']` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `['node_modules']` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold green'` | El estilo del módulo. | | `style` | `'bold green'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `nodejs`. | | `disabled` | `false` | Deshabilita el módulo `nodejs`. |
| `not_capable_style` | `bold red` | El estilo para el módulo cuando una propiedad de motores en package.json no coincide con la versión de Node.js. | | `not_capable_style` | `'bold red'` | El estilo para el módulo cuando una propiedad de motores en package.json no coincide con la versión de Node.js. |
### Variables ### Variables
@ -2890,8 +3033,8 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | El formato del módulo. | | `format` | `'[$symbol]($style)'` | El formato del módulo. |
| `style` | `"bold white"` | El estilo del módulo. | | `style` | `'bold white'` | El estilo del módulo. |
| `disabled` | `true` | Deshabilita el módulo `os`. | | `disabled` | `true` | Deshabilita el módulo `os`. |
| `símbolos` | | A table that maps each operating system to its symbol. | | `símbolos` | | A table that maps each operating system to its symbol. |
@ -2969,7 +3112,7 @@ disabled = false
[os.symbols] [os.symbols]
Windows = " " Windows = " "
Arch = "Arch is the best! " Arch = "Arch es lo mejor! "
``` ```
## Package Version ## Package Version
@ -2999,12 +3142,12 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ----------------- | --------------------------------- | --------------------------------------------------------------------------------------- | | ---------------- | --------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | El formato del módulo. | | `format` | `'is [$symbol$version]($style) '` | El formato del módulo. |
| `symbol` | `'📦 '` | El símbolo usado antes de mostrar la versión del paquete. | | `symbol` | `'📦 '` | El símbolo usado antes de mostrar la versión del paquete. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold 208'` | El estilo del módulo. | | `style` | `'bold 208'` | El estilo del módulo. |
| `display_private` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. | | `'📦 '` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. |
| `disabled` | `false` | Desactiva el módulo `package`. | | `disabled` | `false` | Desactiva el módulo `package`. |
### Variables ### Variables
@ -3023,7 +3166,7 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de
# ~/.config/starship.toml # ~/.config/starship.toml
[package] [package]
format = 'via [🎁 $version](208 bold) ' format = 'vía [🎁 $version](208 bold) '
``` ```
## Perl ## Perl
@ -3150,10 +3293,10 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ---------- | -------------------------------------- | | ----------------- | ---------- | -------------------------------------- |
| version | `v0.12.24` | La versión de `pulumi` | | version | `v0.12.24` | La versión de `pulumi` |
| stack | `dev` | La pila actual de Pulumi | | stack | `dev` | La pila actual de Pulumi |
| username | `alice` | El usuario actual de Pulumi | | nombre de usuario | `alice` | El usuario actual de Pulumi |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3245,7 +3388,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
| `symbol` | `'🐍 '` | Una cadena de formato que representa el símbolo de Python | | `symbol` | `'🐍 '` | Una cadena de formato que representa el símbolo de Python |
| `style` | `'yellow bold'` | El estilo del módulo. | | `style` | `'yellow bold'` | El estilo del módulo. |
| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python | | `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python |
| `pyenv_prefix` | `pyenv` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv | | `pyenv_prefix` | `'pyenv'` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv |
| `python_binary` | `['python', 'python3', 'python2']` | Configura los binarios de python que Starship debería ejecutar al obtener la versión. | | `python_binary` | `['python', 'python3', 'python2']` | Configura los binarios de python que Starship debería ejecutar al obtener la versión. |
| `detect_extensions` | `['py']` | Qué extensiones deben activar este módulo | | `detect_extensions` | `['py']` | Qué extensiones deben activar este módulo |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Qué nombres de archivo deben activar este módulo | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Qué nombres de archivo deben activar este módulo |
@ -3300,7 +3443,7 @@ detect_extensions = []
# ~/.config/starship.toml # ~/.config/starship.toml
[python] [python]
# Muestra la versión de python desde dentro de un entorno virtual local. # Muestra la versión de python dentro de un entorno virtual local.
# #
# Ten en cuenta que esto solo funcionará cuando el venv esté dentro del proyecto y sólo # Ten en cuenta que esto solo funcionará cuando el venv esté dentro del proyecto y sólo
# funcionará en el directorio que contiene el directorio venv dir pero ¿tal vez esté bien? # funcionará en el directorio que contiene el directorio venv dir pero ¿tal vez esté bien?
@ -3563,11 +3706,12 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ---------------------- | ------------------------- | ----------------------------------------------------------------------- | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | Una cadena de formato usada para representar bash. | | `bash_indicator` | `'bsh'` | Una cadena de formato usada para representar bash. |
| `fish_indicator` | `'fsh'` | Una cadena de formato usada para representar fish. | | `fish_indicator` | `'fsh'` | Una cadena de formato usada para representar fish. |
| `zsh_indicator` | `'zsh'` | Una cadena de formato usada para representar zsh. | | `zsh_indicator` | `'zsh'` | Una cadena de formato usada para representar zsh. |
| `powershell_indicator` | `'psh'` | Una cadena de formato usada para representar powershell. | | `powershell_indicator` | `'psh'` | Una cadena de formato usada para representar powershell. |
| `pwsh_indicator` | | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. |
| `ion_indicator` | `'ion'` | Una cadena de formato usada para representar ion. | | `ion_indicator` | `'ion'` | Una cadena de formato usada para representar ion. |
| `elvish_indicator` | `'esh'` | Una cadena de formato usada para representar elvish. | | `elvish_indicator` | `'esh'` | Una cadena de formato usada para representar elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3838,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `"v${major}.${minor}.${patch}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${major}.${minor}.${patch}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `['sol']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold blue"` | El estilo del módulo. | | `style` | `'bold blue'` | El estilo del módulo. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -3857,7 +4001,7 @@ disabled = false
``` ```
```toml ```toml
# En Windows # On windows
# $HOME\.starship\config.toml # $HOME\.starship\config.toml
[sudo] [sudo]
@ -3901,7 +4045,7 @@ Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https:/
# ~/.config/starship.toml # ~/.config/starship.toml
[swift] [swift]
format = 'via [🏎 $version](red bold)' format = 'vía [🏎 $version](red bold)'
``` ```
## Terraform ## Terraform
@ -3945,7 +4089,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
### Ejemplo ### Ejemplo
#### Con la versión de Terraform #### Con Terraform Version
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -3954,7 +4098,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
format = '[🏎💨 $version$workspace]($style) ' format = '[🏎💨 $version$workspace]($style) '
``` ```
#### Sin la versión de Terraform #### Sin Terraform Version
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -4009,6 +4153,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `template.typ`
- The current directory contains any `*.typ` file
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `style` | `'bold #0093A7'` | El estilo del módulo. |
| `detect_extensions` | `['.typ']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['template.typ']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `disabled` | `false` | Deshabilita el módulo `daml`. |
### Variables
| Variable | Ejemplo | Descripción |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
## Username ## Username
El módulo `username` muestra el nombre de usuario activo. El módulo se mostrará si se cumplen alguna de las siguientes condiciones: El módulo `username` muestra el nombre de usuario activo. El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
@ -4283,7 +4460,7 @@ Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell
shell = ['pwsh', '-Command', '-'] shell = ['pwsh', '-Command', '-']
``` ```
::: warning Asegúrate de que tu configuración personalizada de shell salga con éxito ::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito
Si estableces un comando personalizado, asegúrate de que el intérprete de comandos por defecto usado por Starship ejecutará correctamente el comando con una salida elegante (a través de la opción `shell`). Si estableces un comando personalizado, asegúrate de que el intérprete de comandos por defecto usado por Starship ejecutará correctamente el comando con una salida elegante (a través de la opción `shell`).

8
docs/es-ES/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Sigue a @StarshipPrompt en Twitter" alt="Sigue a @StarshipPrompt en Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Alternativamente, instale Starship usando cualquiera de los siguientes gestores
| Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

10
docs/es-ES/presets/README.md
View File

@ -60,6 +60,12 @@ Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbele
## [Tokyo Night](./tokyo-night.md) ## [Tokyo Night](./tokyo-night.md)
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). Este preset está inspirado en [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Captura del preset de Tokyo Night](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
Este preajuste está muy inspirado en [Pastel Powerline](./pastel-powerline.md) y [Tokyo Night](./tokyo-night.md).
[![Captura de pantalla de el preajuste Gruvbox Rainbow](/presets/img/gruvbox-rainbow.png "Clic para ver el preajuste Gruvbox Rainbow")](./gruvbox-rainbow)

21
docs/es-ES/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Volver a Preajustes](./README.md#gruvbox-rainbow)
# Preselección Gruvbox Rainbow
Este preajuste está muy inspirado en [Pastel Powerline](./pastel-powerline.md) y [Tokyo Night](./tokyo-night.md).
![Captura de pantalla del preajuste Gruvbox Rainbow](/presets/img/gruvbox-rainbow.png)
### Prerequisitos
- Una [Nerd Font](https://www.nerdfonts.com/) instalada y habilitada en tu terminal
### Configuración
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Clic para descargar TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/es-ES/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Volver a Preajustes](./README.md#jetpack)
# Preajust Jetpack
Este es un preajuste pseudominimalista inspirado en las indicaciones [geometría](https://github.com/geometry-zsh/geometry) y [nave espacial](https://github.com/spaceship-prompt/spaceship-prompt).
> Jetpack utiliza los colores temáticos de la terminal.
![Captura de pantalla del preajuste Jetpack](/presets/img/jetpack.png)
### Prerrequisito
- Requiere un comando con [`la indicación correcta`](https://starship.rs/advanced-config/#enable-right-prompt).
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) es recomendado.
### Configuración
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Clic para descargar TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

6
docs/es-ES/presets/no-empty-icons.md
View File

@ -1,8 +1,8 @@
[Volver a Preajustes](./README.md#no-empty-icons) [Volver a las preselecciones](./README.md#no-empty-icons)
# No Empty Icons Preset # Preselección de iconos no vacíos
If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined. Si se identifican archivos del conjunto de herramientas, entonces se mostrara el ícono del conjunto de herramientas. If the toolset is not found to determine its version number, it is not displayed. La forma en la que se muestra el ícono depende de si la información del conjunto de herramientas puede ser determinada.
![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png) ![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png)

2
docs/es-ES/presets/no-nerd-font.md
View File

@ -6,7 +6,7 @@ This preset restricts the use of symbols to those from emoji and powerline sets.
Esto significa que incluso sin una fuente Nerd instalada, debería ser capaz de ver todos los símbolos del módulo. Esto significa que incluso sin una fuente Nerd instalada, debería ser capaz de ver todos los símbolos del módulo.
This preset will become the default preset in a future release of starship. Este preset será el predeterminado en una futura versión de starship.
### Configuración ### Configuración

6
docs/es-ES/presets/tokyo-night.md
View File

@ -2,11 +2,11 @@
# Tokyo Night Preset # Tokyo Night Preset
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). Este preset está inspirado en [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png) ![Captura del preset de Tokyo Night](/presets/img/tokyo-night.png)
### Prerequisitos ### Prerrequisitos
- Una [Nerd Font](https://www.nerdfonts.com/) instalada y habilitada en tu terminal - Una [Nerd Font](https://www.nerdfonts.com/) instalada y habilitada en tu terminal

277
docs/fr-FR/config/README.md
View File

@ -206,6 +206,13 @@ Voici la liste des options de configuration globales de l'invite de commandes.
| `add_newline` | `true` | Insère une ligne vide entre les invites du shell. | | `add_newline` | `true` | Insère une ligne vide entre les invites du shell. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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`.
:::
### Exemple ### Exemple
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $custom\
@ -351,6 +361,8 @@ Lorsque vous utilisez [AWSume](https://awsu.me) le profil est lu à partir de la
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 [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.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Tableau des alias de région à afficher en plus du nom AWS. | | `region_aliases` | `{}` | Tableau des alias de région à afficher en plus du nom AWS. |
| `profile_aliases` | `{}` | Tableau des alias de profil à afficher en plus du nom AWS. | | `profile_aliases` | `{}` | Tableau des alias de profil à afficher en plus du nom AWS. |
| `style` | `'bold yellow'` | Le style pour le module. | | `style` | `'bold yellow'` | Le style pour le module. |
| `expiration_symbol` | `X` | Le symbole est affiché lorsque les identifiants temporaires ont expiré. | | `expiration_symbol` | `'X'` | Le symbole est affiché lorsque les identifiants temporaires ont expiré. |
| `disabled` | `false` | Désactive le module `AWS`. | | `disabled` | `false` | Désactive le module `AWS`. |
| `force_display` | `false` | Si `true`, affiche les informations même si `credentials`, `credential_process` ou `sso_start_url` n'ont pas été configurées. | | `force_display` | `false` | Si `true`, affiche les informations même si `credentials`, `credential_process` ou `sso_start_url` n'ont pas été configurées. |
@ -621,14 +633,14 @@ Le module `c` affiche des informations à propos de votre compilateur C. Par dé
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | ------------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | La chaîne de format pour le module. | | `format` | `'via [$symbol($version(-$name) )]($style)'` | La chaîne de format pour le module. |
| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbole` | `'C '` | Le symbole utilisé avant d’afficher les détails du compilateur | | `symbole` | `'C '` | Le symbole utilisé avant d’afficher les détails du compilateur |
| `detect_extensionsdetect_extensions` | `['c', 'h']` | Les extensions qui déclenchent ce module. | | `detect_extensionsdetect_extensions` | `['c', 'h']` | Les extensions qui déclenchent ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | Comment détecter quel est le compilateur | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | Comment détecter quel est le compilateur |
| `style` | `'bold 149'` | Le style pour le module. | | `style` | `'bold 149'` | Le style pour le module. |
| `disabled` | `false` | Désactive le module `c`. | | `disabled` | `false` | Désactive le module `c`. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Options
| Option | Défaut | Description |
| ------------------------------------ | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | Format du module. |
| `symbole` | `'direnv '` | The symbol used before displaying the direnv context. |
| `style` | `'bold orange'` | Le style pour le module. |
| `disabled` | `true` | Disables the `direnv` module. |
| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. |
| `detect_files` | `['.envrc']` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce 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. |
### Variables
| Variable | Exemple | 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. |
| symbole | | Reflète la valeur de l'option `symbol`. |
| style\* | `red bold` | Reflète la valeur de l'option `style`. |
*: Cette variable peut uniquement être utilisée dans une chaine de style
### Exemple
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Contexte Docker ## Contexte Docker
Le module `docker_context` affiche le [context Docker](https://docs.docker.com/engine/context/working-with-contexts/) actif, si sa valeur est différente de `default` ou si les variables d’environnement `DOCKER_MACHINE_NAME`, `DOCKER_HOST` ou `DOCKER_CONTEXT` sont définies (puisqu’elles sont utilisées pour changer le contexte utilisé). Le module `docker_context` affiche le [context Docker](https://docs.docker.com/engine/context/working-with-contexts/) actif, si sa valeur est différente de `default` ou si les variables d’environnement `DOCKER_MACHINE_NAME`, `DOCKER_HOST` ou `DOCKER_CONTEXT` sont définies (puisqu’elles sont utilisées pour changer le contexte utilisé).
@ -1435,7 +1488,7 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe
| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbole` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbole` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Le style pour le module. | | `style` | `'bold green'` | Le style pour le module. |
| `detect_extensionsdetect_extensions` | `[fnl]` | Les extensions qui déclenchent ce module. | | `detect_extensionsdetect_extensions` | `['fnl']` | Les extensions qui déclenchent ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Options
| Option | Défaut | Description |
| -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format du module. |
| `added_style` | `'bold green'` | Le style pour le compte des ajouts. |
| `deleted_style` | `'bold red'` | Le style pour le compte des suppressions. |
| `only_nonzero_diffs` | `true` | Afficher le statut seulement pour les items modifiés. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| Variable | Exemple | Description |
| ----------------- | ------- | --------------------------------------------- |
| added | `1` | Le nombre de lignes ajoutées |
| deleted | `2` | Le nombre de lignes supprimées |
| added_style\* | | Possède la valeur de l’option `added_style` |
| deleted_style\* | | Possède la valeur de l’option `deleted_style` |
*: Cette variable peut uniquement être utilisée dans une chaine de style
### Exemple
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
Le module `gcloud` affiche la version de la commande [`gcloud`](https://cloud.google.com/sdk/gcloud) installée. Ceci est basé sur les fichiers `~/.config/gcloud/active_config` et `~/.config/gcloud/configurations/config_{CONFIG NAME}` et la variable d'environnement `CLOUDSDK_CONFIG`. Le module `gcloud` affiche la version de la commande [`gcloud`](https://cloud.google.com/sdk/gcloud) installée. Ceci est basé sur les fichiers `~/.config/gcloud/active_config` et `~/.config/gcloud/configurations/config_{CONFIG NAME}` et la variable d'environnement `CLOUDSDK_CONFIG`.
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.
### Options ### Options
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | Format du module. | | `format` | `'via [$symbol]($style) '` | Format du module. |
| `symbole` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbole` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | Le style pour le module. | | `style` | `'yellow bold'` | Le style pour le module. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `'via [$symbol($version )]($style)'` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbole` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbole` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensionsdetect_extensions` | `["gradle", "gradle.kts"]` | Les extensions qui déclenchent ce module. | | `detect_extensionsdetect_extensions` | `['gradle', 'gradle.kts']` | Les extensions qui déclenchent ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `["gradle"]` | Les dossiers qui activent ce module. | | `detect_folders` | `['gradle']` | Les dossiers qui activent ce module. |
| `style` | `"bold bright-cyan"` | Le style pour le module. | | `style` | `'bold bright-cyan'` | Le style pour le module. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | ------------------------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `'via [$symbol($version )]($style)'` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `detect_extensionsdetect_extensions` | `["hx", "hxml"]` | Les extensions qui déclenchent ce module. | | `detect_extensionsdetect_extensions` | `['hx', 'hxml']` | Les extensions qui déclenchent ce module. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Les fichiers qui activent ce module. | | `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Les fichiers qui activent ce module. |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Quels dossiers devraient activer ce module. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Quels dossiers devraient activer ce module. |
| `symbole` | `"⌘ "` | Une chaîne de format représentant le symbole de Helm. | | `symbole` | `'⌘ '` | Une chaîne de format représentant le symbole de Helm. |
| `style` | `"bold fg:202"` | Le style pour le module. | | `style` | `'bold fg:202'` | Le style pour le module. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ Le module `hostname` affiche le nom d’hôte du système system.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------ | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Afficher uniquement le nom d'hôte lorsque vous êtes connecté à une session SSH. | | `ssh_only` | `true` | Afficher uniquement le nom d'hôte lorsque vous êtes connecté à une session SSH. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | Chaîne à laquelle le nom d'hôte est coupé, après la première correspondance. `'.'` will stop after the first dot. `''` will disable any truncation | | `trim_at` | `'.'` | Chaîne à laquelle le nom d'hôte est coupé, après la première correspondance. `'.'` 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 '` | Format du module. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | Format du module. |
| `style` | `'bold dimmed green'` | Le style pour le module. | | `style` | `'bold dimmed green'` | Le style pour le module. |
| `disabled` | `false` | Désactive le module `hostname`. | | `disabled` | `false` | Désactive le module `hostname`. |
@ -2126,7 +2215,9 @@ Le module `hostname` affiche le nom d’hôte du système system.
*: Cette variable peut uniquement être utilisée dans une chaine de style *: Cette variable peut uniquement être utilisée dans une chaine de style
### Exemple ### Exemples
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## Java
Le module `java` affiche la version de [Java](https://www.oracle.com/java/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: Le module `java` affiche la version de [Java](https://www.oracle.com/java/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## Kubernetes
Afficher le nom du [contexte Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) courant, et, si défini, l’espace de nom, l’utilisateur, et le cluster depuis le fichier kubeconfig. L'espace de noms doit être défini dans le fichier kubeconfig, ce qui peut être fait via `kubectl config set-context starship-cluster --namespace astronaut`. De même, l'utilisateur et l'instance peuvent être définies avec `kubectl config set-context starship-context --user starship-user` et `kubectl config set-context starship-context --cluster starship-cluster`. Si la variable d'environnement `$KUBECONFIG` est définie, le module l'utilisera, sinon il utilisera le fichier `~/.kube/config`. Afficher le nom du [contexte Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) courant, et, si défini, l’espace de nom, l’utilisateur, et le cluster depuis le fichier kubeconfig. L'espace de noms doit être défini dans le fichier kubeconfig, ce qui peut être fait via `kubectl config set-context starship-cluster --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Si la variable d'environnement `$KUBECONFIG` est définie, le module l'utilisera, sinon il utilisera le fichier `~/.kube/config`.
::: tip ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Options ### Options
::: warning
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------- | | ------------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------- |
| `symbole` | `'☸ '` | Une chaîne de format représentant le symbole affiché avant le Cluster. | | `symbole` | `'☸ '` | Une chaîne de format représentant le symbole affiché avant le Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format du module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format du module. |
| `style` | `'cyan bold'` | Le style pour le module. | | `style` | `'cyan bold'` | Le style pour le module. |
| `context_aliases` | `{}` | Tableau des alias de contexte à afficher. | | `context_aliases`* | `{}` | Tableau des alias de contexte à afficher. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. | | `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Désactiver le module `kubernetes`. | | `disabled` | `true` | Désactiver le module `kubernetes`. |
*: 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:
| Variable | 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. |
| `symbole` | 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)).
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Filtrage par regex #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
L’expression rationnelle doit correspondre au contexte kube entier, et des groupes de capture peuvent être référencés en utilisant `$name` et `$N` dans la valeur de remplacement. Ceci est expliqué plus en détails dans la documentation de [la crate regex](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace).
Les noms de cluster long ou générés automatiquement peuvent être identifiés et raccourcis en utilisant des expressions rationnelles:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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"
``` ```
## Saut de ligne ## Saut de ligne
@ -2730,7 +2861,7 @@ Le module `nodejs` affiche la version de [Node.js](https://nodejs.org/) install
| `detect_folders` | `['node_modules']` | Les dossiers qui activent ce module. | | `detect_folders` | `['node_modules']` | Les dossiers qui activent ce module. |
| `style` | `'bold green'` | Le style pour le module. | | `style` | `'bold green'` | Le style pour le module. |
| `disabled` | `false` | Désactive le module `nodejs`. | | `disabled` | `false` | Désactive le module `nodejs`. |
| `not_capable_style` | `bold red` | Le style du module quand une propriété engines dans le package.json ne correspond pas à la version Node.js. | | `not_capable_style` | `'bold red'` | Le style du module quand une propriété engines dans le package.json ne correspond pas à la version Node.js. |
### Variables ### Variables
@ -2890,8 +3021,8 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | Format du module. | | `format` | `'[$symbol]($style)'` | Format du module. |
| `style` | `"bold white"` | Le style pour le module. | | `style` | `'bold white'` | Le style pour le module. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `symbols` | | A table that maps each operating system to its symbol. |
@ -3245,7 +3376,7 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie:
| `symbole` | `'🐍 '` | Une chaîne de caractères représentant le symbole de Python | | `symbole` | `'🐍 '` | Une chaîne de caractères représentant le symbole de Python |
| `style` | `'yellow bold'` | Le style pour le module. | | `style` | `'yellow bold'` | Le style pour le module. |
| `pyenv_version_name` | `false` | Utiliser pyenv pour obtenir la version de Python | | `pyenv_version_name` | `false` | Utiliser pyenv pour obtenir la version de Python |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensionsdetect_extensions` | `['py']` | Les extensions qui déclenchent ce module | | `detect_extensionsdetect_extensions` | `['py']` | Les extensions qui déclenchent ce module |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Quels fichiers devraient activer ce module | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Quels fichiers devraient activer ce module |
@ -3564,11 +3695,12 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------------------- | ------------------------- | ----------------------------------------------------------- | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | Chaine de formatage utilisée pour représenter bash. | | `bash_indicator` | `'bsh'` | Chaine de formatage utilisée pour représenter bash. |
| `fish_indicator` | `'fsh'` | Chaine de formatage utilisée pour représenter fish. | | `fish_indicator` | `'fsh'` | Chaine de formatage utilisée pour représenter fish. |
| `zsh_indicator` | `'zsh'` | Chaine de formatage utilisée pour représenter zsh. | | `zsh_indicator` | `'zsh'` | Chaine de formatage utilisée pour représenter zsh. |
| `powershell_indicator` | `'psh'` | Chaine de formatage utilisée pour représenter powershell. | | `powershell_indicator` | `'psh'` | Chaine de formatage utilisée pour représenter powershell. |
| `pwsh_indicator` | | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. |
| `ion_indicator` | `'ion'` | Chaine de formatage utilisée pour représenter ion. | | `ion_indicator` | `'ion'` | Chaine de formatage utilisée pour représenter ion. |
| `elvish_indicator` | `'esh'` | Chaine de formatage utilisée pour représenter elvish. | | `elvish_indicator` | `'esh'` | Chaine de formatage utilisée pour représenter elvish. |
| `tcsh_indicator` | `'tsh'` | Chaine de formatage utilisée pour représenter tcsh. | | `tcsh_indicator` | `'tsh'` | Chaine de formatage utilisée pour représenter tcsh. |
@ -3695,14 +3827,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `'via [$symbol($version )]($style)'` | Format du module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${major}.${minor}.${patch}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbole` | `"S "` | A format string representing the symbol of Solidity | | `symbole` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensionsdetect_extensions` | `["sol"]` | Les extensions qui déclenchent ce module. | | `detect_extensionsdetect_extensions` | `['sol']` | Les extensions qui déclenchent ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"bold blue"` | Le style pour le module. | | `style` | `'bold blue'` | Le style pour le module. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4010,6 +4142,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
Par défaut, le module sera affiché si l’une de ces conditions est remplie:
- Le dossier courant contient un fichier `template.typ`
- The current directory contains any `*.typ` file
### Options
| Option | Défaut | Description |
| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbole` | `'t '` | A format string representing the symbol of Daml |
| `style` | `'bold #0093A7'` | Le style pour le module. |
| `detect_extensionsdetect_extensions` | `['.typ']` | Les extensions qui déclenchent ce module. |
| `detect_files` | `['template.typ']` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Exemple | Description |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbole | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
*: Cette variable peut uniquement être utilisée dans une chaine de style
## Nom d'utilisateur ## Nom d'utilisateur
Le module `username` affiche le nom de l’utilisateur actif. Le module sera affiché si l'une de ces conditions est remplie: Le module `username` affiche le nom de l’utilisateur actif. Le module sera affiché si l'une de ces conditions est remplie:

16
docs/fr-FR/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Suivez @StarshipPrompt sur Twitter" alt="Suivez @StarshipPrompt sur Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![Bannière StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de
| Gentoo | [Paquets Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Paquets Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Paquets Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Paquets Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>
@ -277,7 +281,7 @@ Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans l
<details> <details>
<summary>Bash</summary> <summary>Bash</summary>
Ajoutez ce qui suit à la fin de `~/.bashrc`: Ajouter ce qui suit à la fin de `~/.bashrc`:
```sh ```sh
eval "$(starship init bash)" eval "$(starship init bash)"
@ -312,7 +316,7 @@ Note: Seul Elvish v0.18+ est supporté
<details> <details>
<summary>Fish</summary> <summary>Fish</summary>
Ajoutez le code suivant à la fin de `~/.config/fish/config.fish`: Ajoute ce qui suit à la fin de `~/.config/fish/config.fish`:
```fish ```fish
starship init fish | source starship init fish | source
@ -323,7 +327,7 @@ starship init fish | source
<details> <details>
<summary>Ion</summary> <summary>Ion</summary>
Ajoutez ce qui suit à la fin de `~/.config/ion/initrc`: Ajouter ce qui suit à la fin de `~/.config/ion/initrc`:
```sh ```sh
eval $(starship init ion) eval $(starship init ion)
@ -387,7 +391,7 @@ execx($(starship init xonsh))
<details> <details>
<summary>Zsh</summary> <summary>Zsh</summary>
Ajoutez ce qui suit à la fin de `~/.zshrc`: Ajouter ce qui suit à la fin de `~/.zshrc`:
```sh ```sh
eval "$(starship init zsh)" eval "$(starship init zsh)"

6
docs/fr-FR/presets/README.md
View File

@ -63,3 +63,9 @@ Ce préréglage s'inspire de [M365Princess](https://github.com/JanDeDobbeleer/oh
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/fr-FR/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Retourner aux préréglages](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### Pré-requis
- Une [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal
### Configuration
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Cliquez pour télécharger le TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/fr-FR/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Retourner aux préréglages](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Configuration
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Cliquez pour télécharger le TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

297
docs/id-ID/config/README.md
View File

@ -206,6 +206,13 @@ Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide.
| `add_newline` | `true` | Memasukkan baris kosong antara prompt shell. | | `add_newline` | `true` | Memasukkan baris kosong antara prompt shell. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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`.
:::
### Contoh ### Contoh
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $custom\
@ -351,6 +361,8 @@ Ketika menggunakan [AWSume](https://awsu.me) profil dibaca dari variabel environ
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 [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.
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Tabel alias dari region yang ditampilan selain nama AWS. | | `region_aliases` | `{}` | Tabel alias dari region yang ditampilan selain nama AWS. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. |
| `expiration_symbol` | `X` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. | | `expiration_symbol` | `'X'` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. |
| `disabled` | `false` | Menonaktifkan modul `AWS`. | | `disabled` | `false` | Menonaktifkan modul `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | | `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['c', 'h']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | Gaya penataan untuk modul. | | `style` | `'bold 149'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | Format dari modul. |
| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |
| `style` | `'bold orange'` | Gaya penataan untuk modul. |
| `disabled` | `true` | Disables the `direnv` module. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['.envrc']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `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. |
### Variabel
| Variabel | Contoh | Deskripsi |
| --------- | ------------------- | --------------------------------------- |
| 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 | | Menyalin nilai dari opsi `symbol`. |
| style\* | `red bold` | Menyalin nilai dari opsi `style`. |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
### Contoh
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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).
@ -1393,7 +1446,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | The symbol used before displaying the version of erlang. | | `symbol` | `' '` | The symbol used before displaying the version of erlang. |
| `style` | `'bold red'` | Gaya penataan untuk modul. | | `style` | `'bold red'` | Gaya penataan untuk modul. |
@ -1435,7 +1488,7 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Gaya penataan untuk modul. | | `style` | `'bold green'` | Gaya penataan untuk modul. |
| `detect_extensions` | `[fnl]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['fnl']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Opsi
| Opsi | Bawaan | Deskripsi |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `fromat` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format dari modul. |
| `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. |
### Variabel
| Variabel | Contoh | Deskripsi |
| ----------------- | ------ | ------------------------------------------- |
| 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` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
### Contoh
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Opsi ### Opsi
@ -1775,7 +1863,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `fromat` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `'='` | This branch has merge conflicts. | | `conflicted` | `'='` | This branch has merge conflicts. |
| `ahead` | `'⇡'` | The format of `ahead` | | `ahead` | `'⇡'` | The format of `ahead` |
| `behind` | `'⇣'` | The format of `behind` | | `behind` | `'⇣'` | The format of `behind` |
@ -1930,9 +2018,9 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | Format dari modul. | | `fromat` | `'via [$symbol]($style) '` | Format dari modul. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | Gaya penataan untuk modul. | | `style` | `'yellow bold'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variabel ### Variabel
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `["gradle"]` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `['gradle']` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `"bold bright-cyan"` | Gaya penataan untuk modul. | | `style` | `'bold bright-cyan'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["hx", "hxml"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['hx', 'hxml']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Folder mana yang sebaiknya memicul modul ini. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | Gaya penataan untuk modul. | | `style` | `'bold fg:202'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variabel ### Variabel
@ -2108,10 +2196,11 @@ The `hostname` module shows the system hostname.
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `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. | | `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 | | `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. |
| `fromat` | `'[$ssh_symbol$hostname]($style) in '` | Format dari modul. | | `fromat` | `'[$ssh_symbol$hostname]($style) in '` | Format dari modul. |
| `style` | `'bold dimmed green'` | Gaya penataan untuk modul. | | `style` | `'bold dimmed green'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2128,6 +2217,8 @@ The `hostname` module shows the system hostname.
### Contoh ### Contoh
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## Java
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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 ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Opsi ### Opsi
::: warning
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `fromat` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. | | `fromat` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. |
| `style` | `'cyan bold'` | Gaya penataan untuk modul. | | `style` | `'cyan bold'` | Gaya penataan untuk modul. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `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:
| Variabel | Deskripsi |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `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. |
| `symbol` | 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)).
### Variabel ### Variabel
| Variabel | Contoh | Deskripsi | | Variabel | Contoh | Deskripsi |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## Line Break
@ -2637,7 +2768,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -2674,7 +2805,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. | | `fromat` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | Gaya penataan untuk modul. | | `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
@ -2722,7 +2853,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | A format string representing the symbol of Node.js. | | `symbol` | `' '` | A format string representing the symbol of Node.js. |
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -2730,7 +2861,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| `detect_folders` | `['node_modules']` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `['node_modules']` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `'bold green'` | Gaya penataan untuk modul. | | `style` | `'bold green'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |
### Variabel ### Variabel
@ -2767,7 +2898,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string for the module. | | `fromat` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. | | `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. |
| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. | | `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. |
@ -2807,7 +2938,7 @@ The `opa` module shows the currently installed version of the OPA tool. By defau
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. | | `symbol` | `'🪖 '` | A format string representing the symbol of OPA. |
| `detect_extensions` | `['rego']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['rego']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -2843,7 +2974,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------- | ----------------------------------------------- | -------------------------------------------------------------- | | ---------- | ----------------------------------------------- | -------------------------------------------------------------- |
| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | Format dari modul. | | `fromat` | `'on [$symbol$cloud(\($project\))]($style) '` | Format dari modul. |
| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. | | `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `openstack` module. | | `disabled` | `false` | Disables the `openstack` module. |
@ -2890,8 +3021,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | Format dari modul. | | `fromat` | `'[$symbol]($style)'` | Format dari modul. |
| `style` | `"bold white"` | Gaya penataan untuk modul. | | `style` | `'bold white'` | Gaya penataan untuk modul. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `symbols` | | A table that maps each operating system to its symbol. |
@ -3000,7 +3131,7 @@ The `package` module is shown when the current directory is the repository for a
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ----------------- | --------------------------------- | ----------------------------------------------------------------------------------- | | ----------------- | --------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | Format dari modul. | | `fromat` | `'is [$symbol$version]($style) '` | Format dari modul. |
| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold 208'` | Gaya penataan untuk modul. | | `style` | `'bold 208'` | Gaya penataan untuk modul. |
@ -3040,7 +3171,7 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | | `fromat` | `'via [$symbol($version )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | | `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl |
| `detect_extensions` | `['pl', 'pm', 'pod']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['pl', 'pm', 'pod']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3245,7 +3376,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | Gaya penataan untuk modul. | | `style` | `'yellow bold'` | Gaya penataan untuk modul. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | Ekstensi mana yang sebaiknya memicu modul ini | | `detect_extensions` | `['py']` | Ekstensi mana yang sebaiknya memicu modul ini |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | filenames mana yang sebaiknya memicu modul ini | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | filenames mana yang sebaiknya memicu modul ini |
@ -3563,11 +3694,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `"v${major}.${minor}.${patch}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${major}.${minor}.${patch}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['sol']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `"bold blue"` | Gaya penataan untuk modul. | | `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variabel ### Variabel
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- Direktori ini memiliki berkas `template.typ`
- The current directory contains any `*.typ` file
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `style` | `'bold #0093A7'` | Gaya penataan untuk modul. |
| `detect_extensions` | `['.typ']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['template.typ']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `disabled` | `false` | Disables the `daml` module. |
### Variabel
| Variabel | Contoh | Deskripsi |
| ------------- | -------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `bawaan` | The current Typst version |
| symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
## Username ## 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:

8
docs/id-ID/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Ikuti @StarshipPrompt di Twitter" alt="Ikuti @StarshipPrompt di Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Alternatively, install Starship using any of the following package managers:
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

6
docs/id-ID/presets/README.md
View File

@ -63,3 +63,9 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/id-ID/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### Prasyarat
- [Nerd Font](https://www.nerdfonts.com/) yang sudah terpasang dan berjalan di dalam terminalmu
### Konfigurasi
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/id-ID/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Return to Presets](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Konfigurasi
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

281
docs/it-IT/config/README.md
View File

@ -206,6 +206,13 @@ This is the list of prompt-wide configuration options.
| `add_newline` | `true` | Inserisce una riga vuota tra i prompt della shell. | | `add_newline` | `true` | Inserisce una riga vuota tra i prompt della shell. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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`.
:::
### Esempio ### Esempio
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $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 [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.
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | Lo stile per il modulo. | | `style` | `'bold yellow'` | Lo stile per il modulo. |
| `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` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. | | `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['c', 'h']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | Lo stile per il modulo. | | `style` | `'bold 149'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. |
| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |
| `style` | `'bold orange'` | Lo stile per il modulo. |
| `disabled` | `true` | Disables the `direnv` module. |
| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `['.envrc']` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `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. |
### Variables
| Variable | Esempio | Descrizione |
| --------- | ------------------- | --------------------------------------- |
| 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 | | 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
### Esempio
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Lo stile per il modulo. | | `style` | `'bold green'` | Lo stile per il modulo. |
| `detect_extensions` | `[fnl]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['fnl']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Opzioni
| Opzione | Default | Descrizione |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `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. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| Variable | Esempio | Descrizione |
| ----------------- | ------- | ------------------------------------------- |
| 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
### Esempio
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Opzioni ### Opzioni
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | The format for the module. | | `format` | `'via [$symbol]($style) '` | The format for the module. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | Lo stile per il modulo. | | `style` | `'yellow bold'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `["gradle"]` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `['gradle']` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `"bold bright-cyan"` | Lo stile per il modulo. | | `style` | `'bold bright-cyan'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["hx", "hxml"]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['hx', 'hxml']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Which folders should trigger this modules. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | Lo stile per il modulo. | | `style` | `'bold fg:202'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ The `hostname` module shows the system hostname.
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `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. | | `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 | | `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. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | Lo stile per il modulo. | | `style` | `'bold dimmed green'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2126,7 +2215,9 @@ The `hostname` module shows the system hostname.
*: 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
### Esempio ### Examples
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## 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:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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 ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Opzioni ### Opzioni
::: warning
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `'cyan bold'` | Lo stile per il modulo. | | `style` | `'cyan bold'` | Lo stile per il modulo. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `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:
| Variable | Descrizione |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `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. |
| `symbol` | 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)).
### Variables ### Variables
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## Line Break
@ -2730,7 +2861,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| `detect_folders` | `['node_modules']` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `['node_modules']` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `'bold green'` | Lo stile per il modulo. | | `style` | `'bold green'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `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 ### Variables
@ -2890,8 +3021,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | The format for the module. | | `format` | `'[$symbol]($style)'` | The format for the module. |
| `style` | `"bold white"` | Lo stile per il modulo. | | `style` | `'bold white'` | Lo stile per il modulo. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `symbols` | | A table that maps each operating system to its symbol. |
@ -3039,9 +3170,9 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | | `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl |
| `detect_extensions` | `['pl', 'pm', 'pod']` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['pl', 'pm', 'pod']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Quali nomi di file dovrebbero attivare questo modulo. |
@ -3245,7 +3376,7 @@ By default the module will be shown if any of the following conditions are met:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | Lo stile per il modulo. | | `style` | `'yellow bold'` | Lo stile per il modulo. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | Quali estensioni dovrebbero attivare questo modulo | | `detect_extensions` | `['py']` | Quali estensioni dovrebbero attivare questo modulo |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Quali nomi di file dovrebbero attivare questo modulo | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Quali nomi di file dovrebbero attivare questo modulo |
@ -3563,11 +3694,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${major}.${minor}.${patch}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['sol']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `"bold blue"` | Lo stile per il modulo. | | `style` | `'bold blue'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- The current directory contains a `template.typ` file
- The current directory contains any `*.typ` file
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `style` | `'bold #0093A7'` | Lo stile per il modulo. |
| `detect_extensions` | `['.typ']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `['template.typ']` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Esempio | Descrizione |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
## Username ## 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:

8
docs/it-IT/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Segui @StarshipPrompt su Twitter" alt="Segui @StarshipPrompt su Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Alternatively, install Starship using any of the following package managers:
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

6
docs/it-IT/presets/README.md
View File

@ -63,3 +63,9 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/it-IT/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### Prerequisiti
- Un [ Nerd Font ](https://www.nerdfonts.com/) installato e abilitato nel tuo terminale
### Configurazione
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/it-IT/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Return to Presets](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Configurazione
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

6
docs/ja-JP/README.md
View File

@ -50,12 +50,12 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
#### パッケージマネージャー経由でインストール #### パッケージマネージャー経由でインストール
[ Homebrew ](https://brew.sh/)の場合： [ Homebrew](https://brew.sh/)を使用する
```sh ```sh
brew install starship brew install starship
``` ```
With [Winget](https://github.com/microsoft/winget-cli): [Winget](https://github.com/microsoft/winget-cli)を使用する
```powershell ```powershell
winget install starship winget install starship
@ -153,7 +153,7 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
::: :::
Nushellの環境ファイルの最後に以下を追記してください ( `$nu.env-path` を実行してください): そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）:
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu

277
docs/ja-JP/config/README.md
View File

@ -206,6 +206,13 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts']
| `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 | | `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $custom\
@ -351,6 +361,8 @@ The module will display a profile only if its credentials are present in `~/.aws
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 [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名に加えて表示するリージョンのエイリアスです。 | | `region_aliases` | `{}` | AWS名に加えて表示するリージョンのエイリアスです。 |
| `profile_aliases` | `{}` | AWS名に加えて表示するプロファイルのエイリアスです。 | | `profile_aliases` | `{}` | AWS名に加えて表示するプロファイルのエイリアスです。 |
| `style` | `'bold yellow'` | モジュールのスタイルです。 | | `style` | `'bold yellow'` | モジュールのスタイルです。 |
| `expiration_symbol` | `X` | この記号は一時的な資格情報が有効期限切れの場合に表示されます。 | | `expiration_symbol` | `'X'` | この記号は一時的な資格情報が有効期限切れの場合に表示されます。 |
| `disabled` | `false` | `aws`モジュールを無効にします。 | | `disabled` | `false` | `aws`モジュールを無効にします。 |
| `force_display` | `false` | `true`の場合、`credentials`、`credential_process`または`sso_start_url`が設定されていない場合でも情報を表示します。 | | `force_display` | `false` | `true`の場合、`credentials`、`credential_process`または`sso_start_url`が設定されていない場合でも情報を表示します。 |
@ -621,14 +633,14 @@ format = 'via [🍔 $version](bold green) '
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------ | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | モジュールのフォーマット文字列。 | | `format` | `'via [$symbol($version(-$name) )]($style)'` | モジュールのフォーマット文字列。 |
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `'C '` | コンパイラの詳細を表示する前に使用される記号です。 | | `symbol` | `'C '` | コンパイラの詳細を表示する前に使用される記号です。 |
| `detect_extensions` | `['c', 'h']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `['c', 'h']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | コンパイラを検出する方法 | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | コンパイラを検出する方法 |
| `style` | `'bold 149'` | モジュールのスタイルです。 | | `style` | `'bold 149'` | モジュールのスタイルです。 |
| `disabled` | `false` | `c`モジュールを無効にします。 | | `disabled` | `false` | `c`モジュールを無効にします。 |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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) '` | module のフォーマットです。 |
| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |
| `style` | `'bold orange'` | モジュールのスタイルです。 |
| `disabled` | `true` | Disables the `direnv` module. |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `['.envrc']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `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 | | オプション `symbol` の値をミラーする. |
| style\* | `red bold` | オプション `style` の値をミラーする. |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
### 設定例
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
`docker_context`モジュールは、`default`に設定されていない場合、または環境変数`DOCKER_MACHINE_NAME`、`DOCKER_HOST`または`DOCKER_CONTEXT`が設定されている場合 (使用中のコンテキストを上書きするため)、現在アクティブな[Docker context](https://docs.docker.com/engine/context/working-with-contexts/)を表示します。 `docker_context`モジュールは、`default`に設定されていない場合、または環境変数`DOCKER_MACHINE_NAME`、`DOCKER_HOST`または`DOCKER_CONTEXT`が設定されている場合 (使用中のコンテキストを上書きするため)、現在アクティブな[Docker context](https://docs.docker.com/engine/context/working-with-contexts/)を表示します。
@ -1435,7 +1488,7 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | モジュールのスタイルです。 | | `style` | `'bold green'` | モジュールのスタイルです。 |
| `detect_extensions` | `[fnl]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `['fnl']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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) )'` | module のフォーマットです。 |
| `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`) ## Google Cloud (`gcloud`)
`gcloud` モジュールは、 [`gcloud`](https://cloud.google.com/sdk/gcloud) CLIの現在の設定が表示されます。 これは `~/.config/gcloud/active_config` ファイルと `~/.config/gcloud/configurations/config_{CONFIG NAME}` ファイルと `CLOUDSDK_CONFIG` 環境変数に基づきます。 `gcloud` モジュールは、 [`gcloud`](https://cloud.google.com/sdk/gcloud) CLIの現在の設定が表示されます。 これは `~/.config/gcloud/active_config` ファイルと `~/.config/gcloud/configurations/config_{CONFIG NAME}` ファイルと `CLOUDSDK_CONFIG` 環境変数に基づきます。
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) '` | module のフォーマットです。 | | `format` | `'via [$symbol]($style) '` | module のフォーマットです。 |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | モジュールのスタイルです。 | | `style` | `'yellow bold'` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `guix_shell` module. | | `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)"` | module のフォーマットです。 | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `['gradle', 'gradle.kts']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `["gradle"]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `['gradle']` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold bright-cyan"` | モジュールのスタイルです。 | | `style` | `'bold bright-cyan'` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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)"` | module のフォーマットです。 | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `detect_extensions` | `["hx", "hxml"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `['hx', 'hxml']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | どのフォルダーがこのモジュールをアクティブにするか |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | モジュールのスタイルです。 | | `style` | `'bold fg:202'` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### 変数 ### 変数
@ -2108,10 +2196,11 @@ format = 'via [⎈ $version](bold white) '
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------- | | ----------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 | | `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to 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 | | `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 '` | module のフォーマットです。 | | `format` | `'[$ssh_symbol$hostname]($style) in '` | module のフォーマットです。 |
| `style` | `'bold dimmed green'` | モジュールのスタイルです。 | | `style` | `'bold dimmed green'` | モジュールのスタイルです。 |
| `disabled` | `false` | `hostname`モジュールを無効にします。 | | `disabled` | `false` | `hostname`モジュールを無効にします。 |
@ -2128,6 +2217,8 @@ format = 'via [⎈ $version](bold white) '
### 設定例 ### 設定例
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## Java
`Java`モジュールは、現在インストールされている[Java](https://www.oracle.com/java/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 `Java`モジュールは、現在インストールされている[Java](https://www.oracle.com/java/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## Kubernetes
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. 環境変数`$KUBECONFIG`が設定されている場合、このモジュールはそれを利用し、`~/.kube/config`を利用しません。 Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. 環境変数`$KUBECONFIG`が設定されている場合、このモジュールはそれを利用し、`~/.kube/config`を利用しません。
::: tip ::: 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.
:::
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ---------------------------------------------------- | --------------------------------- | | ------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `symbol` | `'☸ '` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 | | `symbol` | `'☸ '` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 |
| `style` | `'cyan bold'` | モジュールのスタイルです。 | | `style` | `'cyan bold'` | モジュールのスタイルです。 |
| `context_aliases` | `{}` | コンテキストの表示エイリアスを定義するテーブル。 | | `context_aliases`* | `{}` | コンテキストの表示エイリアスを定義するテーブル。 |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | `kubernetes` モジュールを無効にする。 | | `disabled` | `true` | `kubernetes` モジュールを無効にする。 |
*: 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. |
| `symbol` | 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] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## Line Break
@ -2730,7 +2861,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
| `detect_folders` | `['node_modules']` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `['node_modules']` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `'bold green'` | モジュールのスタイルです。 | | `style` | `'bold green'` | モジュールのスタイルです。 |
| `disabled` | `false` | `nodejs`モジュールを無効にします。 | | `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)"` | module のフォーマットです。 | | `format` | `'[$symbol]($style)'` | module のフォーマットです。 |
| `style` | `"bold white"` | モジュールのスタイルです。 | | `style` | `'bold white'` | モジュールのスタイルです。 |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `symbols` | | A table that maps each operating system to its symbol. |
@ -3245,7 +3376,7 @@ The `python` module shows the currently installed version of [Python](https://ww
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | モジュールのスタイルです。 | | `style` | `'yellow bold'` | モジュールのスタイルです。 |
| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | | `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `['py']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | どのファイル名がこのモジュールをアクティブにするか |
@ -3563,11 +3694,12 @@ The `shell` module shows an indicator for currently used shell.
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
| `version_format` | `"v${major}.${minor}.${patch}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `'v${major}.${minor}.${patch}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `['sol']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `style` | `'bold blue'` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### 変数 ### 変数
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`template.typ`ファイルが含まれている
- The current directory contains any `*.typ` file
### オプション
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `'t '` | Damlの記号を表すフォーマット文字列です。 |
| `style` | `'bold #0093A7'` | モジュールのスタイルです。 |
| `detect_extensions` | `['.typ']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `['template.typ']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | `daml`モジュールを無効にします。 |
### 変数
| 変数 | 設定例 | 説明 |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | オプション `symbol` の値をミラーする |
| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
## ユーザー名 ## ユーザー名
`username`モジュールはアクティブなユーザーのユーザー名を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: `username`モジュールはアクティブなユーザーのユーザー名を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:

20
docs/ja-JP/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Follow @StarshipPrompt on Twitter" alt="Follow @StarshipPrompt on Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -177,7 +180,7 @@
### 必要なもの ### 必要なもの
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)). - [Nerd Font](https://www.nerdfonts.com/)がインストールされ、端末にて有効になっている（例えば、[FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)を試してみてください）。
### Step 1. Starshipをインストール ### Step 1. Starshipをインストール
@ -229,6 +232,7 @@ curl -sS https://starship.rs/install.sh | sh
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>
@ -270,7 +274,7 @@ curl -sS https://starship.rs/install.sh | sh
</details> </details>
### Step 2. Set up your shell to use Starship ### Step 2. Starshipをシェルにセットアップ
Starshipを初期化するためのシェルの設定。 以下のリストからお使いのシェルを選択してください。 Starshipを初期化するためのシェルの設定。 以下のリストからお使いのシェルを選択してください。
@ -334,27 +338,27 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Nushellの環境ファイルの最後に以下を追記してください ( `$nu.env-path` を実行してください): そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）:
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）。 そして、Nushellの設定ファイルの最後に以下を追記してください (`$nu.config-path` を実行してください):
```sh ```sh
use ~/.cache/starship/init.nu use ~/.cache/starship/init.nu
``` ```
注意: Elvish v0.78以降でサポートされています 注意: Nushell v0.78以降でサポートされています
</details> </details>
<details> <details>
<summary>PowerShell</summary> <summary>PowerShell</summary>
PowerShellの設定ファイルの最後に以下を追記してください (`$PROFILE` を実行してください): そして、Nushellの設定ファイルの最後に以下を追加してください（ `$PROFILE.config-path` を実行してください）:
```powershell ```powershell
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

6
docs/ja-JP/presets/README.md
View File

@ -63,3 +63,9 @@ This preset does not show icons if the toolset is not found.
このプリセットは[tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme)を参考にしています。 このプリセットは[tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme)を参考にしています。
[![Tokyo Night プリセットのスクリーンショット](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Tokyo Night プリセットのスクリーンショット](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/ja-JP/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[プリセット一覧に戻る](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### 必要なもの
- [Nerd Font](https://www.nerdfonts.com/)のインストールとターミナルでの有効化
### 設定
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[クリックしてTOMLをダウンロード](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/ja-JP/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[プリセット一覧に戻る](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### 設定
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[クリックしてTOMLをダウンロード](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

36
docs/ko-KR/README.md
View File

@ -2,23 +2,23 @@
home: true home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: 간결하고 화끈하게 빠르며 무제한으로 커스터마이징이 가능한 프롬프트. 어떤 쉘에서든 사용할 수 있습니다! tagline: 아무 셸에나 적용할 수 있는 작고, 매우 빠르며, 무한히 커스텀 가능한 프롬프트입니다!
actionText: Get Started → actionText: 시작하기 →
actionLink: ./guide/ actionLink: ./guide/
features: features:
- -
title: Compatibility First title: 호환성 우선
details: Works on the most common shells on the most common operating systems. Use it everywhere! details: 거의 모든 운영 체제의 거의 모든 셸에서 동작합니다. 모든 곳에서 사용해 보세요!
- -
title: Rust-Powered title: Rust 기반
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible. details: Rust의 최고 수준의 속도와 안정성으로 프롬프트를 가능한 한 빠르고 안정적으로 만들어 보세요.
- -
title: Customizable title: 커스텀 가능
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be. details: 모든 사소한 디테일들을 마음대로 커스텀할 수 있어, 프롬프트를 원하는 만큼 간단하게 만들거나 기능이 풍부하게 만들 수 있습니다.
footer: ISC Licensed | Copyright © 2019-present Starship Contributors footer: ISC Licensed | Copyright © 2019-present Starship Contributors
#Used for the description meta tag, for SEO #Used for the description meta tag, for SEO
metaTitle: "Starship: Cross-Shell Prompt" metaTitle: "Starship: 크로스-셸 프롬프트"
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell. description: Starship은 아무 셸에나 적용할 수 있는 작고, 매우 빠르며, 무한히 커스텀 가능한 프롬프트입니다! 필요한 정보를 깔끔하고 간략하게 표시합니다. Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, 및 PowerShell에 빠르게 설치할 수 있습니다.
--- ---
<div class="center"> <div class="center">
@ -39,7 +39,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### 최근 버전 설치 #### 최근 버전 설치
With Shell: 셸로 설치:
```sh ```sh
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
@ -48,14 +48,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
Starship을 업데이트하고 싶은 경우에도 위의 스크립트를 실행시키면 됩니다. Starship의 설정은 변경되지 않고 버전만 최근 버전으로 대체될 것입니다. Starship을 업데이트하고 싶은 경우에도 위의 스크립트를 실행시키면 됩니다. Starship의 설정은 변경되지 않고 버전만 최근 버전으로 대체될 것입니다.
#### 패키지 매니저를 이용한 설치 #### 패키지 매니저로 설치하기
[Homebrew](https://brew.sh/)를 통한 설치: [Homebrew](https://brew.sh/)로 설치:
```sh ```sh
brew install starship brew install starship
``` ```
With [Winget](https://github.com/microsoft/winget-cli): [Winget](https://github.com/microsoft/winget-cli)으로 설치:
```powershell ```powershell
winget install starship winget install starship
@ -121,7 +121,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: warning
Only elvish v0.18 or higher is supported. elvish 버전 v0.18 이상에서만 지원됩니다.
::: :::
@ -149,17 +149,17 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: warning
This will change in the future. Only Nushell v0.78+ is supported. 추후에 변경될 예정입니다. Nushell v0.78 버전 이상에서만 지원됩니다.
::: :::
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): 다음 내용을 Nushell env 파일 (찾으려면 Nushell에서 `$nu.env-path` 실행) 마지막 부분에 추가하세요:
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): 다음 내용을 Nushell 설정 파일 (찾으려면 Nushell에서 `$nu.config-path` 실행) 마지막 부분에 추가하세요:
```sh ```sh
use ~/.cache/starship/init.nu use ~/.cache/starship/init.nu

36
docs/ko-KR/advanced-config/README.md
View File

@ -1,4 +1,4 @@
# Advanced Configuration # 고급 설정
While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship.
@ -199,27 +199,27 @@ function Invoke-Starship-PreCommand {
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```
## Enable Right Prompt ## 오른쪽 프롬프트 활성화
Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. 일부 셸은 입력과 같은 줄에 렌더링되는 오른쪽 프롬프트를 지원합니다. Starship에서는 `right_format` 옵션을 사용하여 오른쪽 프롬프트의 내용을 설정할 수 있습니다. `format`에서 사용할 수 있는 모든 모듈은 `right_format`에서도 지원됩니다. `$all` 변수는 `format` 또는 `right_format`에서 명시적으로 사용하지 않는 모듈만 포함합니다.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). 알림: 오른쪽 프롬프트는 입력 위치에 따라 한 줄로 표시됩니다. 여러 줄 프롬프트에서 입력 선 위의 모듈을 오른쪽 정렬하려면, [`fill` 모듈](/config/#fill)을 참고하세요.
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. `right_format`은 현재 elvish, fish, zsh, xonsh, cmd, nushell에서 지원됩니다.
### Example ### 예시
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
# A minimal left prompt # 간결한 왼쪽 프롬프트
format = """$character""" format = """$character"""
# move the rest of the prompt to the right # 프롬프트의 나머지를 오른쪽으로 옮기기
right_format = """$all""" right_format = """$all"""
``` ```
Produces a prompt like the following: 위 설정은 아래와 같은 프롬프트를 출력합니다:
``` ```
▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s ▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
@ -239,7 +239,7 @@ Note: Continuation prompts are only available in the following shells:
- `zsh` - `zsh`
- `Powershell` - `Powershell`
### Example ### 예시
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -248,9 +248,9 @@ Note: Continuation prompts are only available in the following shells:
continuation_prompt = '▶▶ ' continuation_prompt = '▶▶ '
``` ```
## Style Strings ## 스타일 문자열
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following: 스타일 문자열은 공백으로 구분된 단어 목록입니다. 단어는 대소문자를 구분하지 않습니다 (즉, `bold`와 `BoLd`는 동일한 문자열로 간주됩니다). 각 단어는 다음 중 하나가 될 수 있습니다:
- `bold` - `bold`
- `italic` - `italic`
@ -265,15 +265,15 @@ Style strings are a list of words, separated by whitespace. The words are not ca
- `<color>` - `<color>`
- `none` - `none`
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. `<color>` 부분은 색상 지정자입니다 (아래에 후술). 현재, `fg:<color>` 와 `<color>`는 동일한 동작을 하지만 차후에 바뀔 수 있습니다. `inverted`는 배경 색과 전경 색을 서로 바꿉니다. 문자열의 단어 순서는 중요하지 않습니다.
The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. It may become an error to use `none` in conjunction with other tokens in the future. The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 향후 다른 토큰과 함께 `none`을 사용하는 것은 오류가 발생할 수 있습니다.
A color specifier can be one of the following: 색상 지정자는 다음 중 하나가 될 수 있습니다:
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`). - 표준 터미널 색상: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. 앞에 `bright-`를 붙여 밝게 만들 수도 있습니다 (예시: `bright-white`).
- A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp). - `#` 다음의 여섯 자리 16진수 숫자. 이는 [RGB 색상 16진수 코드](https://www.w3schools.com/colors/colors_hexadecimal.asp)입니다.
- A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png). - 0~255 사이의 숫자. 이는 [8비트 ANSI 색상 코드](https://i.stack.imgur.com/KTSQa.png)입니다.
If multiple colors are specified for foreground/background, the last one in the string will take priority. If multiple colors are specified for foreground/background, the last one in the string will take priority.

949
docs/ko-KR/config/README.md
View File

File diff suppressed because it is too large Load Diff

42
docs/ko-KR/faq/README.md
View File

@ -1,14 +1,14 @@
# Frequently Asked Questions # 자주 묻는 질문
## What is the configuration used in the demo GIF? ## 데모 GIF에는 어떤 구성을 사용했나요?
- **Terminal Emulator**: [iTerm2](https://iterm2.com/) - **터미널 에뮬레이터**: [iTerm2](https://iterm2.com/)
- **Theme**: Minimal - **테마**: Minimal
- **Color Scheme**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy) - **배색**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy)
- **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) - **폰트**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)
- **Shell**: [Fish Shell](https://fishshell.com/) - **셸**: [Fish Shell](https://fishshell.com/)
- **Configuration**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **구성**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish)
- **Prompt**: [Starship](https://starship.rs/) - **프롬프트**: [Starship](https://starship.rs/)
## How do I get command completion as shown in the demo GIF? ## How do I get command completion as shown in the demo GIF?
@ -40,7 +40,7 @@ PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations. The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations.
For a list of all flags accepted by `starship prompt`, use the following command: `starship 프롬프트`에서 지원하는 모든 플래그 값을 보려면 아래 명령어를 사용하세요:
```sh ```sh
starship prompt --help starship prompt --help
@ -48,19 +48,19 @@ starship prompt --help
The prompt will use as much context as is provided, but no flags are "required". The prompt will use as much context as is provided, but no flags are "required".
## How do I run Starship on Linux distributions with older versions of glibc? ## 오래된 버전의 glibc가 있는 Linux 배포판에서 Starship을 어떻게 실행하나요?
If you get an error like "_version 'GLIBC_2.18' not found (required by starship)_" when using the prebuilt binary (for example, on CentOS 6 or 7), you can use a binary compiled with `musl` instead of `glibc`: 미리 빌드된 바이너리를 실행할 때 (예를 들어 CentOS 6 혹은 7에서) "_version 'GLIBC_2.18' not found (required by starship)_" 같은 오류가 보인다면, `glibc` 대신 `musl`로 컴파일된 바이너리 파일을 사용하세요.
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
``` ```
## Why do I see `Executing command "..." timed out.` warnings? ## 왜 `Executing command "..." timed out.` 경고가 뜨나요?
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](/config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings. Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](/config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
## I see symbols I don't understand or expect, what do they mean? ## 이해할 수 없거나 예상치 못한 기호가 보이는데 무슨 뜻인가요?
If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules. If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules.
@ -105,18 +105,18 @@ The first line should produce a [snake emoji](https://emojipedia.org/snake/), wh
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose) If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
## How do I uninstall Starship? ## Starship을 어떻게 삭제하나요?
Starship is just as easy to uninstall as it is to install in the first place. Starship은 처음 설치하는 것만큼이나 쉽게 제거할 수 있습니다.
1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship. 1. 셸 설정 파일 (예시: `~/.bashrc`) 에서 Starship 초기화에 사용되는 모든 줄을 제거하세요.
1. Delete the Starship binary. 1. Starship 바이너리 파일을 제거하세요.
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions. Starship을 패키지 매니저로 설치하였다면 해당 패키지 매니저의 제거 지침 문서를 참조해 주세요.
If Starship was installed using the install script, the following command will delete the binary: Starship을 설치 스크립트로 설치하였다면 바이너리 파일 제거를 위해 아래 명령어를 실행하세요:
```sh ```sh
# Locate and delete the starship binary # starship 바이너리 파일을 찾고 제거합니다.
sh -c 'rm "$(command -v 'starship')"' sh -c 'rm "$(command -v 'starship')"'
``` ```

92
docs/ko-KR/guide/README.md
View File

@ -2,7 +2,7 @@
<img <img
width="400" width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png" src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
alt="Starship – Cross-shell prompt" alt="Starship – 크로스-쉘 프롬프트"
/> />
</p> </p>
@ -30,7 +30,12 @@
<a href="https://twitter.com/StarshipPrompt" <a href="https://twitter.com/StarshipPrompt"
><img ><img
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="트위터에서 @StarshipPrompt를 팔로우 하세요" alt="X에서 @StarshipPrompt 팔로우하기"
/></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a> /></a>
</p> </p>
@ -147,25 +152,23 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
alt="Starship with iTerm2 and the Snazzy theme" alt="ITerm2, Snazzy 테마가 포함된 Starship"
width="50%" width="50%"
align="right" align="right"
/> />
**간결하고 화끈하게 빠르며 무제한으로 커스터마이징이 가능한 프롬프트. 어떤 쉘에서든 사용할 수 있습니다!** **아무 셸에나 적용할 수 있는 간결하고, 매우 빠르며, 무한히 커스텀 가능한 프롬프트입니다!**
- ** Fast:** 빨라요 – _엄청 엄청_ 빠릅니다! 🚀 - ** 빠름:** 빠릅니다. – _정말_ 빠릅니다. 🚀
- ** Customizable:** 프롬프트의 모든 측면을 커스텀 가능합니다. - ** 커스텀 가능:** 프롬프트의 모든 부분을 커스텀 할 수 있습니다.
- **Universal:** 어떤 쉘 위에서도, 어떤 운영체제 위에서도 동작합니다. - **범용적:** 어떤 셸 위에서도, 어떤 운영체제 위에서도 동작합니다.
- **Intelligent:** 관련 정보를 한눈에 보여줍니다. - **지능적:** 관련 정보를 한눈에 보여줍니다.
- **Feature rich:** 원하는 모든 도구를 지원합니다. - **다기능:** 원하는 모든 도구를 지원합니다.
- **Easy:** 빠른 설치 - 몇 분 안에 사용할 수 있습니다. - **쉬움:** 빠른 설치 - 몇 분만 투자하면 바로 사용할 수 있습니다.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Starship 문서 보기&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/config/"><strong>Starship 문서 보기&nbsp;&nbsp;▶</strong></a>
@ -188,7 +191,7 @@
다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요: 다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요:
| Repository | Instructions | | 리포지토리 | 설명 |
| --------------------------------------------------------------------------------- | ---------------------- | | --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
@ -199,9 +202,9 @@
다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요: 다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요:
| Distribution | Repository | Instructions | | 배포판 | 리포지토리 | 설명 |
| ------------ | -------------------------------------------------------- | --------------------------------- | | -------- | -------------------------------------------------------- | --------------------------------- |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_전체_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | | FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` | | NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
@ -218,18 +221,19 @@ curl -sS https://starship.rs/install.sh | sh
다음의 패키지 관리자를 사용해서 Starship을 설치할 수도 있습니다. 다음의 패키지 관리자를 사용해서 Starship을 설치할 수도 있습니다.
| Distribution | Repository | Instructions | | 배포판 | 리포지토리 | 설명 |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | ------------------ | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_전체_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | _전체_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| _Any_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | | _전체_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | | Alpine Linux 3.13+ | [Alpine Linux 패키지](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` | | Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo 패키지](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux 패키지](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>
@ -244,7 +248,7 @@ curl -sS https://starship.rs/install.sh | sh
다음의 패키지 관리자를 사용해서 Starship을 설치할 수도 있습니다. 다음의 패키지 관리자를 사용해서 Starship을 설치할 수도 있습니다.
| Repository | Instructions | | 리포지토리 | 설명 |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -256,11 +260,11 @@ curl -sS https://starship.rs/install.sh | sh
<details> <details>
<summary>Windows</summary> <summary>Windows</summary>
Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). [releases 섹션](https://github.com/starship/starship/releases/latest)에서 MSI 인스톨러를 받아 실행하여 시스템에 맞는 최신 버전을 설치하세요.
다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요: 다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요:
| Repository | Instructions | | 리포지토리 | 설명 |
| -------------------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
@ -270,9 +274,9 @@ Install the latest version for your system with the MSI-installers from the [rel
</details> </details>
### 2단계. Set up your shell to use Starship ### 2단계. 셸에 Starship 적용하기
쉘에 Starship 초기 설정을 합니다. 아래의 리스트 중에 해당하는 것을 고르세요: Starship 적용을 위해 셸을 구성해야 합니다. 아래의 리스트 중에 해당하는 것을 고르세요:
<details> <details>
<summary>Bash</summary> <summary>Bash</summary>
@ -288,7 +292,7 @@ eval "$(starship init bash)"
<details> <details>
<summary>Cmd</summary> <summary>Cmd</summary>
Cmd를 이용하려면 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 를 사용해야 합니다. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: Cmd를 이용하려면 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 를 사용해야 합니다. `%LocalAppData%\clink\starship.lua` 경로에 파일을 만들고 아래 내용으로 채우세요:
```lua ```lua
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
@ -305,7 +309,7 @@ load(io.popen('starship init cmd'):read("*a"))()
eval (starship init elvish) eval (starship init elvish)
``` ```
Note: Only Elvish v0.18+ is supported 알림: Elvish v0.18 버전 이상에서만 지원됩니다.
</details> </details>
@ -334,20 +338,20 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): 다음 내용을 Nushell env 파일 (찾으려면 Nushell에서 `$nu.env-path` 실행) 마지막 부분에 추가하세요:
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): 다음 내용을 Nushell 설정 파일 (찾으려면 Nushell에서 `$nu.config-path` 실행) 마지막 부분에 추가하세요:
```sh ```sh
use ~/.cache/starship/init.nu use ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.78+ is supported 알림: Nushell v0.78 버전 이상에서만 지원됩니다.
</details> </details>
@ -409,25 +413,25 @@ Starship을 추가로 커스터마이징 하고싶다면:
우리는 언제나 **기술 수준에 관계없이** 기여자를 찾고 있습니다! 프로젝트에 참여하고자 한다면, [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) 를 보내보세요. 우리는 언제나 **기술 수준에 관계없이** 기여자를 찾고 있습니다! 프로젝트에 참여하고자 한다면, [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) 를 보내보세요.
If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. 번역에 도움을 주고자 한다면, [Starship Crowdin](https://translate.starship.rs/) 에서 기여할 수 있습니다. 영어 이외의 언어에 유창하시다면, 저희 문서를 다른 언어로 최신화하는 데 도움을 주시면 대단히 감사하겠습니다. 번역에 도움을 주고자 한다면, [Starship Crowdin](https://translate.starship.rs/) 에서 기여할 수 있습니다.
Starship 에 기여하는데 관심이 있다면, [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) 를 한 번 살펴봐 주세요 그리고 부담갖지 말고 [Discord 서버](https://discord.gg/8Jzqu3T) 에 들러 인사 한 마디 남겨보세요 👋 Starship에 기여하는데 관심이 있으시다면, [기여 가이드](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)를 읽어주세요. 그리고 부담갖지 말고 [Discord 서버](https://discord.gg/8Jzqu3T) 에 들러 인사 한 마디 남겨보세요 👋
## 💭 Inspired By ## 💭 영감받은 곳
Starship 을 만드는 데에 영감이 되었던 이전 작업들도 살펴보세요. 🙏 Starship 을 만드는 데에 영감이 되었던 이전 작업들도 살펴보세요. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – 우주 비행사를 위한 ZSH 프롬프트.
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – Cross-shell robbyrussell theme written in JavaScript. - **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – JavaScript로 작성된 크로스-쉘 robbyrussell 테마.
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons. - **[reujab/silver](https://github.com/reujab/silver)** – 아이콘이 있는 커스텀 가능한 powerline 계열 크로스-쉘 프롬프트.
## ❤️ Sponsors ## ❤️ 스폰서
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website. 이 [프로젝트를 후원](https://github.com/sponsors/starship)하여 프로젝트를 지원해 주세요. 여러분의 웹사이트로 이동하는 링크가 걸린 이름 혹은 로고가 여기에 걸립니다.
**Supporter Tier** **후원자 티어**
- [Appwrite](https://appwrite.io/) - [Appwrite](https://appwrite.io/)
@ -438,4 +442,4 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
## 📝라이선스 ## 📝라이선스
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. Copyright © 2019-현재, [Starship 기여자](https://github.com/starship/starship/graphs/contributors).<br /> 이 프로젝트는 [ISC](https://github.com/starship/starship/blob/master/LICENSE) 라이선스입니다.

2
docs/ko-KR/installing/README.md
View File

@ -63,7 +63,7 @@ Enable the `programs.starship` module in your `home.nix` file, and add your sett
{ {
programs.starship = { programs.starship = {
enable = true; enable = true;
# Configuration written to ~/.config/starship.toml # ~/.config/starship.toml에 작성된 설정
settings = { settings = {
# add_newline = false; # add_newline = false;

2
docs/ko-KR/migrating-to-0.45.0/README.md
View File

@ -80,7 +80,7 @@ format = "took [$duration]($style) "
| Removed Property | Replacement | | Removed Property | Replacement |
| ----------------------- | ---------------- | | ----------------------- | ---------------- |
| `symbol` | `success_symbol` | | `기호` | `success_symbol` |
| `use_symbol_for_status` | `error_symbol` | | `use_symbol_for_status` | `error_symbol` |
| `style_success` | `success_symbol` | | `style_success` | `success_symbol` |
| `style_failure` | `error_symbol` | | `style_failure` | `error_symbol` |

34
docs/ko-KR/presets/README.md
View File

@ -1,14 +1,14 @@
# Presets # 프리셋
Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊 커뮤니티가 제공한 Starship 설정 프리셋의 모음집입니다. 공유할 프리셋이 있다면 이 파일을 [수정하는 PR을 제출](https://github.com/starship/starship/edit/master/docs/presets/README.md)해 주세요! 😊
To get details on how to use a preset, simply click on the image. 프리셋 사용 방법에 대한 자세한 내용을 보려면 이미지를 클릭하기만 하면 됩니다.
## [Nerd Font Symbols](./nerd-font.md) ## [Nerd Font 기호](./nerd-font.md)
This preset changes the symbols for each module to use Nerd Font symbols. 이 프리셋은 각 모듈의 기호가 Nerd Font 기호를 사용하도록 변경합니다.
[![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) [![Nerd Font 기호 프리셋 스크린샷](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font)
## [No Nerd Fonts](./no-nerd-font.md) ## [No Nerd Fonts](./no-nerd-font.md)
@ -16,11 +16,11 @@ This preset changes the symbols for several modules so that no Nerd Font symbols
::: tip ::: tip
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). 이 프리셋은 [starship의 추후 배포](https://github.com/starship/starship/pull/3544)에서 기본 프리셋이 될 예정입니다.
::: :::
[Click to view No Nerd Font preset](./no-nerd-font) [클릭하여 No Nerd Font 프리셋 보기](./no-nerd-font)
## [Bracketed Segments](./bracketed-segments.md) ## [Bracketed Segments](./bracketed-segments.md)
@ -40,17 +40,17 @@ This preset hides the version of language runtimes. If you work in containers or
[![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes)
## [No Empty Icons](./no-empty-icons.md) ## [빈 아이콘 제거](./no-empty-icons.md)
This preset does not show icons if the toolset is not found. 이 프리셋은 툴셋을 찾을 수 없을 때 아이콘을 표시하지 않습니다.
[![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png "Click to view No Runtime Versions preset")](./no-empty-icons.md) [![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png "Click to view No Runtime Versions preset")](./no-empty-icons.md)
## [Pure Prompt](./pure-preset.md) ## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). 이 프리셋은 [Pure](https://github.com/sindresorhus/pure)의 모습과 동작을 재현합니다.
[![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset) [![Pure 프리셋 스크린샷](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset)
## [Pastel Powerline](./pastel-powerline.md) ## [Pastel Powerline](./pastel-powerline.md)
@ -60,6 +60,12 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
## [Tokyo Night](./tokyo-night.md) ## [Tokyo Night](./tokyo-night.md)
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). 이 프리셋은 [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme)에서 영감을 받았습니다.
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Tokyo Night 프리셋 스크린샷](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
이 프리셋은 [Pastel Powerline](./pastel-powerline.md) 및 [Tokyo Night](./tokyo-night.md)에서 강하게 영감을 받았습니다.
[![Gruvbox Rainbow 프리셋 스크린샷](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

6
docs/ko-KR/presets/bracketed-segments.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#bracketed-segments) [프리셋으로 돌아가기](./README.md#bracketed-segments)
# Bracketed Segments Preset # Bracketed Segments Preset
@ -6,12 +6,12 @@ This preset changes the format of all the built-in modules to show their segment
![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png) ![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png)
### Configuration ### 설정
```sh ```sh
starship preset bracketed-segments -o ~/.config/starship.toml starship preset bracketed-segments -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/bracketed-segments.toml) [클릭하여 TOML 다운로드](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/.vuepress/public/presets/toml/bracketed-segments.toml

21
docs/ko-KR/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[프리셋으로 돌아가기](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow 프리셋
이 프리셋은 [Pastel Powerline](./pastel-powerline.md) 및 [Tokyo Night](./tokyo-night.md)에서 강하게 영감을 받았습니다.
![Gruvbox Rainbow 프리셋 스크린샷](/presets/img/gruvbox-rainbow.png)
### 준비 사항
- 터미널에 [Nerd Font](https://www.nerdfonts.com/) 설치 및 활성화
### 설정
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[클릭하여 TOML 다운로드](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/ko-KR/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[프리셋으로 돌아가기](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### 설정
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[클릭하여 TOML 다운로드](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

16
docs/ko-KR/presets/nerd-font.md
View File

@ -1,21 +1,21 @@
[Return to Presets](./README.md#nerd-font-symbols) [프리셋으로 돌아가기](./README.md#nerd-font-symbols)
# Nerd Font Symbols Preset # Nerd Font 기호 프리셋
This preset changes the symbols for each module to use Nerd Font symbols. 이 프리셋은 각 모듈의 기호가 Nerd Font 기호를 사용하도록 변경합니다.
![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png) ![Nerd Font 기호 프리셋 스크린샷](/presets/img/nerd-font-symbols.png)
### 준비 사항 ### 필요 사항
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) - 터미널에 [Nerd Font](https://www.nerdfonts.com/) 설치 및 활성화 (예시에서는 Fira Code Nerd Font를 사용합니다.)
### Configuration ### 설정
```sh ```sh
starship preset nerd-font-symbols -o ~/.config/starship.toml starship preset nerd-font-symbols -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/nerd-font-symbols.toml) [클릭하여 TOML 다운로드](/presets/toml/nerd-font-symbols.toml)
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml <<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml

6
docs/ko-KR/presets/no-empty-icons.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-empty-icons) [프리셋으로 돌아가기](./README.md#no-empty-icons)
# No Empty Icons Preset # No Empty Icons Preset
@ -6,12 +6,12 @@ If toolset files are identified the toolset icon is displayed. If the toolset is
![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png) ![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png)
### Configuration ### 설정
```sh ```sh
starship preset no-empty-icons -o ~/.config/starship.toml starship preset no-empty-icons -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/no-empty-icons.toml) [클릭하여 TOML 다운로드](/presets/toml/no-empty-icons.toml)
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml <<< @/.vuepress/public/presets/toml/no-empty-icons.toml

6
docs/ko-KR/presets/no-nerd-font.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-nerd-fonts) [프리셋으로 돌아가기](./README.md#no-nerd-fonts)
# No Nerd Fonts Preset # No Nerd Fonts Preset
@ -8,12 +8,12 @@ This means that even without a Nerd Font installed, you should be able to view a
This preset will become the default preset in a future release of starship. This preset will become the default preset in a future release of starship.
### Configuration ### 설정
```sh ```sh
starship preset no-nerd-font -o ~/.config/starship.toml starship preset no-nerd-font -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/no-nerd-font.toml) [클릭하여 TOML 다운로드](/presets/toml/no-nerd-font.toml)
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml <<< @/.vuepress/public/presets/toml/no-nerd-font.toml

6
docs/ko-KR/presets/no-runtimes.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-runtime-versions) [프리셋으로 돌아가기](./README.md#no-runtime-versions)
# No Runtime Versions Preset # No Runtime Versions Preset
@ -6,12 +6,12 @@ This preset hides the version of language runtimes. If you work in containers or
![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png) ![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png)
### Configuration ### 설정
```sh ```sh
starship preset no-runtime-versions -o ~/.config/starship.toml starship preset no-runtime-versions -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/no-runtime-versions.toml) [클릭하여 TOML 다운로드](/presets/toml/no-runtime-versions.toml)
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml <<< @/.vuepress/public/presets/toml/no-runtime-versions.toml

6
docs/ko-KR/presets/pastel-powerline.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [프리셋으로 돌아가기](./README.md#pastel-powerline)
# Pastel Powerline Preset # Pastel Powerline Preset
@ -10,12 +10,12 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font)
### Configuration ### 설정
```sh ```sh
starship preset pastel-powerline -o ~/.config/starship.toml starship preset pastel-powerline -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/pastel-powerline.toml) [클릭하여 TOML 다운로드](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml <<< @/.vuepress/public/presets/toml/pastel-powerline.toml

6
docs/ko-KR/presets/plain-text.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#plain-text-symbols) [프리셋으로 돌아가기](./README.md#plain-text-symbols)
## Plain Text Symbols Preset ## Plain Text Symbols Preset
@ -6,12 +6,12 @@ This preset changes the symbols for each module into plain text. Great if you do
![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png) ![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png)
### Configuration ### 설정
```sh ```sh
starship preset plain-text-symbols -o ~/.config/starship.toml starship preset plain-text-symbols -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/plain-text-symbols.toml) [클릭하여 TOML 다운로드](/presets/toml/plain-text-symbols.toml)
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml <<< @/.vuepress/public/presets/toml/plain-text-symbols.toml

12
docs/ko-KR/presets/pure-preset.md
View File

@ -1,17 +1,17 @@
[Return to Presets](./README.md#pure) [프리셋으로 돌아가기](./README.md#pure)
# Pure Preset # Pure 프리셋
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). 이 프리셋은 [Pure](https://github.com/sindresorhus/pure)의 모습과 동작을 재현합니다.
![Screenshot of Pure preset](/presets/img/pure-preset.png) ![Pure 프리셋 스크린샷](/presets/img/pure-preset.png)
### Configuration ### 설정
```sh ```sh
starship preset pure-preset -o ~/.config/starship.toml starship preset pure-preset -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/pure-preset.toml) [클릭하여 TOML 다운로드](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml <<< @/.vuepress/public/presets/toml/pure-preset.toml

14
docs/ko-KR/presets/tokyo-night.md
View File

@ -1,21 +1,21 @@
[Return to Presets](./README.md#pastel-powerline) [프리셋으로 돌아가기](./README.md#pastel-powerline)
# Tokyo Night Preset # Tokyo Night 프리셋
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). 이 프리셋은 [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme)에서 영감을 받았습니다.
![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png) ![Tokyo Night 프리셋 스크린샷](/presets/img/tokyo-night.png)
### 준비 사항 ### 준비 사항
- 터미널에 [Nerd Font](https://www.nerdfonts.com/)가 설치되어 있고 사용 가능해야 합니다 - 터미널에 [Nerd Font](https://www.nerdfonts.com/) 설치 및 활성화
### Configuration ### 설정
```sh ```sh
starship preset tokyo-night -o ~/.config/starship.toml starship preset tokyo-night -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/tokyo-night.toml) [클릭하여 TOML 다운로드](/presets/toml/tokyo-night.toml)
<<< @/.vuepress/public/presets/toml/tokyo-night.toml <<< @/.vuepress/public/presets/toml/tokyo-night.toml

277
docs/nl-NL/config/README.md
View File

@ -206,6 +206,13 @@ This is the list of prompt-wide configuration options.
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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`.
:::
### Example ### Example
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $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 [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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | The style for the module. | | `style` | `'bold yellow'` | The style for the module. |
| `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` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | | `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders 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 | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | The style for the module. | | `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Options
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. |
| `symbol` | `'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. |
| `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. |
### Variables
| Variable | Example | 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. |
| symbol | | 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
### Example
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `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_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Options
| 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. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Options ### Options
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | The format for the module. | | `format` | `'via [$symbol]($style) '` | The format for the module. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | | `detect_folders` | `['gradle']` | Which folders should trigger this module. |
| `style` | `"bold bright-cyan"` | The style for the module. | | `style` | `'bold bright-cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `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_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_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. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | The style for the module. | | `style` | `'bold fg:202'` | The style for the module. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `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. | | `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 | | `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. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | The style for the module. | | `style` | `'bold dimmed green'` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2126,7 +2215,9 @@ The `hostname` module shows the system hostname.
*: 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
### Example ### Examples
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## 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:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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 ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Options ### 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 |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `'cyan bold'` | The style for the module. | | `style` | `'cyan bold'` | The style for the module. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `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:
| Variable | 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. |
| `symbol` | 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)).
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## 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. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `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 ### Variables
@ -2890,8 +3021,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | The format for the module. | | `format` | `'[$symbol]($style)'` | The format for the module. |
| `style` | `"bold white"` | The style for the module. | | `style` | `'bold white'` | The style for the module. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `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:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `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_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_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
@ -3563,11 +3694,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `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` | | `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. | | `detect_extensions` | `['sol']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- The current directory contains a `template.typ` file
- The current directory contains any `*.typ` file
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `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 `daml` module. |
### Variables
| Variable | Example | Description |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
## Username ## 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:

8
docs/nl-NL/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Volg @StarshipPrompt op Twitter" alt="Volg @StarshipPrompt op Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Alternatively, install Starship using any of the following package managers:
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

6
docs/nl-NL/presets/README.md
View File

@ -63,3 +63,9 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/nl-NL/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### Benodigdheden
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
### Configuration
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/nl-NL/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Return to Presets](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Configuration
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

277
docs/no-NO/config/README.md
View File

@ -206,6 +206,13 @@ This is the list of prompt-wide configuration options.
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `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`.
:::
### Example ### Example
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $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 [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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | The style for the module. | | `style` | `'bold yellow'` | The style for the module. |
| `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` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | | `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders 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 | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | The style for the module. | | `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Options
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. |
| `symbol` | `'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. |
| `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. |
### Variables
| Variable | Example | 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. |
| symbol | | 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
### Example
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `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_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Options
| 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. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Options ### Options
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | The format for the module. | | `format` | `'via [$symbol]($style) '` | The format for the module. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | | `detect_folders` | `['gradle']` | Which folders should trigger this module. |
| `style` | `"bold bright-cyan"` | The style for the module. | | `style` | `'bold bright-cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `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_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_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. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | The style for the module. | | `style` | `'bold fg:202'` | The style for the module. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `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. | | `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 | | `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. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | The style for the module. | | `style` | `'bold dimmed green'` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2126,7 +2215,9 @@ The `hostname` module shows the system hostname.
*: 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
### Example ### Examples
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## 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:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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 ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Options ### 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 |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `'cyan bold'` | The style for the module. | | `style` | `'cyan bold'` | The style for the module. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `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:
| Variable | 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. |
| `symbol` | 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)).
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## 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. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `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 ### Variables
@ -2890,8 +3021,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | The format for the module. | | `format` | `'[$symbol]($style)'` | The format for the module. |
| `style` | `"bold white"` | The style for the module. | | `style` | `'bold white'` | The style for the module. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `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:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `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_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_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
@ -3563,11 +3694,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `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` | | `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. | | `detect_extensions` | `['sol']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- The current directory contains a `template.typ` file
- The current directory contains any `*.typ` file
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `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 `daml` module. |
### Variables
| Variable | Example | Description |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
## Username ## 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:

8
docs/no-NO/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Følg @StarshipPrompt på Twitter" alt="Følg @StarshipPrompt på Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Alternatively, install Starship using any of the following package managers:
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

6
docs/no-NO/presets/README.md
View File

@ -63,3 +63,9 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night) [![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./gruvbox-rainbow)

21
docs/no-NO/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Return to Presets](./README.md#gruvbox-rainbow)
# Gruvbox Rainbow Preset
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
### Nødvendig forutsetninger
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
### Configuration
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/no-NO/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Return to Presets](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Prerequisite
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Configuration
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

277
docs/pl-PL/config/README.md
View File

@ -206,6 +206,13 @@ This is the list of prompt-wide configuration options.
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: porada
If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
:::
### Example ### Example
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $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 [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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | The style for the module. | | `style` | `'bold yellow'` | The style for the module. |
| `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` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@ -621,14 +633,14 @@ The `c` module shows some information about your C compiler. By default the modu
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details | | `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. | | `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders 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 | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |
| `style` | `'bold 149'` | The style for the module. | | `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Options
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. |
| `symbol` | `'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. |
| `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. |
### Variables
| Zmienne | Example | 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. |
| symbol | | 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
### Example
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). 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` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `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_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Options
| 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. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variables
| Zmienne | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## 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.
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.
### Options ### Options
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | The format for the module. | | `format` | `'via [$symbol]($style) '` | The format for the module. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variables ### Variables
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | | `detect_folders` | `['gradle']` | Which folders should trigger this module. |
| `style` | `"bold bright-cyan"` | The style for the module. | | `style` | `'bold bright-cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `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_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_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. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | The style for the module. | | `style` | `'bold fg:202'` | The style for the module. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variables ### Variables
@ -2108,10 +2196,11 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `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. | | `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 | | `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. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | The style for the module. | | `style` | `'bold dimmed green'` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2126,7 +2215,9 @@ The `hostname` module shows the system hostname.
*: 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
### Example ### Examples
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## 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:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## 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`.
::: porada ::: porada
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Options ### 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 |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `'cyan bold'` | The style for the module. | | `style` | `'cyan bold'` | The style for the module. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `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:
| Zmienne | 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. |
| `symbol` | 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)).
### Variables ### Variables
| Zmienne | Example | Description | | Zmienne | Example | Description |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Regex Matching #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
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.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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 ## 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. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | The style for the module. | | `style` | `'bold green'` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `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 ### Variables
@ -2890,8 +3021,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | The format for the module. | | `format` | `'[$symbol]($style)'` | The format for the module. |
| `style` | `"bold white"` | The style for the module. | | `style` | `'bold white'` | The style for the module. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `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:
| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | The style for the module. | | `style` | `'yellow bold'` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `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. | | `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_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_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
@ -3563,11 +3694,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. | | `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. | | `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | | `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | | `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. | | `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | | `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | | `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `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` | | `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. | | `detect_extensions` | `['sol']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variables ### Variables
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
By default, the module will be shown if any of the following conditions are met:
- The current directory contains a `template.typ` file
- The current directory contains any `*.typ` file
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `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 `daml` module. |
### Variables
| Zmienne | Example | Description |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
## Username ## 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:

2
docs/pl-PL/faq/README.md
View File

@ -21,7 +21,7 @@ Yes, they can both be used to disable modules in the prompt. If all you plan to
- Disabling modules is more explicit than omitting them from the top level `format` - Disabling modules is more explicit than omitting them from the top level `format`
- Newly created modules will be added to the prompt as Starship is updated - Newly created modules will be added to the prompt as Starship is updated
## Dokumentacja stwierdza że Starship jest wieloplatformowy. Dlaczego moja preferowana powłoka nie jest obsługiwana? ## Dokumentacja twierdzi, że Starship jest wieloplatformowy. Dlaczego moja preferowana powłoka nie jest obsługiwana?
The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used. The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used.

8
docs/pl-PL/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Śledź @StarshipPrompt na Twitterze" alt="Śledź @StarshipPrompt na Twitterze"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Wspieraj Ukrainę"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbaner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Alternatywnie, zainstaluj Starship używając dowolnego z następujących mened
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

6
docs/pl-PL/presets/README.md
View File

@ -63,3 +63,9 @@ Ten zestaw ustawień jest inspirowany [M365Princess](https://github.com/JanDeDo
Ten zestaw ustawień jest inspirowany [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). Ten zestaw ustawień jest inspirowany [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
[![Zrzut ekranu ustawień Tokio Night](/presets/img/tokyo-night.png "Kliknij, aby wyświetlić ustawienia Tokio Night")](./tokyo-night) [![Zrzut ekranu ustawień Tokio Night](/presets/img/tokyo-night.png "Kliknij, aby wyświetlić ustawienia Tokio Night")](./tokyo-night)
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
Zestaw mocno inspirowany przez [Pastel Powerline](./pastel-powerline.md) i [Tokyo Night](./tokyo-night.md).
[![Zrzut ekranu ustawień Gruvbox Rainbow](/presets/img/gruvbox-rainbow.png "Kliknij, aby wyświetlić ustawienia Gruvbox Rainbow")](./gruvbox-rainbow)

21
docs/pl-PL/presets/gruvbox-rainbow.md Normal file
View File

@ -0,0 +1,21 @@
[Powrót do ustawień predefiniowanych](./README.md#gruvbox-rainbow)
# Ustawienia Gruvbox Rainbow
Zestaw mocno inspirowany przez [Pastel Powerline](./pastel-powerline.md) i [Tokyo Night](./tokyo-night.md).
![Zrzut ekranu ustawień Gruvbox Rainbow](/presets/img/gruvbox-rainbow.png)
### Wymagania wstępne
- Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i włączona w twoim terminalu
### Konfiguracja
```sh
starship preset gruvbox-rainbow -o ~/.config/starship.toml
```
[Kliknij, aby pobrać TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml

24
docs/pl-PL/presets/jetpack.md Normal file
View File

@ -0,0 +1,24 @@
[Powrót do ustawień predefiniowanych](./README.md#jetpack)
# Jetpack Preset
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
> Jetpack uses the terminal's color theme.
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
### Wymaganie wstępne
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
### Konfiguracja
```sh
starship preset jetpack -o ~/.config/starship.toml
```
[Kliknij, aby pobrać TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml

285
docs/pt-BR/config/README.md
View File

@ -206,6 +206,13 @@ Esta é a lista de opções de configuração em todo o prompt.
| `add_newline` | `true` | Insere linha vazia entre os prompts do shell. | | `add_newline` | `true` | Insere linha vazia entre os prompts do shell. |
| `palette` | `''` | Define qual a paleta de cores de `palettes` será usada. | | `palette` | `''` | Define qual a paleta de cores de `palettes` será usada. |
| `palettes` | `{}` | Coleção de paletas de cores que atribuem [cores](/advanced-config/#style-strings) aos nomes definidos pelo usuário. Note que paletas de cores não podem referir-se a suas próprias definições de cores. | | `palettes` | `{}` | Coleção de paletas de cores que atribuem [cores](/advanced-config/#style-strings) aos nomes definidos pelo usuário. Note que paletas de cores não podem referir-se a suas próprias definições de cores. |
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip
If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
:::
### Exemplo ### Exemplo
@ -253,6 +260,7 @@ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\ $fossil_branch\
$fossil_metrics\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
@ -301,6 +309,7 @@ $scala\
$solidity\ $solidity\
$swift\ $swift\
$terraform\ $terraform\
$typst\
$vlang\ $vlang\
$vagrant\ $vagrant\
$zig\ $zig\
@ -314,6 +323,7 @@ $aws\
$gcloud\ $gcloud\
$openstack\ $openstack\
$azure\ $azure\
$direnv\
$env_var\ $env_var\
$crystal\ $crystal\
$custom\ $custom\
@ -351,6 +361,8 @@ Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROF
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 [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.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
@ -360,7 +372,7 @@ When using [saml2aws](https://github.com/Versent/saml2aws) the expiration inform
| `region_aliases` | `{}` | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. | | `region_aliases` | `{}` | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. |
| `profile_aliases` | `{}` | Tabela de apelidos de perfil a serem exibidos além do nome da AWS. | | `profile_aliases` | `{}` | Tabela de apelidos de perfil a serem exibidos além do nome da AWS. |
| `style` | `'bold yellow'` | O estilo do módulo. | | `style` | `'bold yellow'` | O estilo do módulo. |
| `expiration_symbol` | `X` | O simbolo exibido quando as credenciais temporárias estão expiradas. | | `expiration_symbol` | `'X'` | O simbolo exibido quando as credenciais temporárias estão expiradas. |
| `disabled` | `false` | Desabilita o módulo `AWS`. | | `disabled` | `false` | Desabilita o módulo `AWS`. |
| `force_display` | `false` | Se `true` exibe as informações mesmo que `credentials`, `credential_process` ou `sso_start_url` não tenham sido configurados. | | `force_display` | `false` | Se `true` exibe as informações mesmo que `credentials`, `credential_process` ou `sso_start_url` não tenham sido configurados. |
@ -423,7 +435,7 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
## Azure ## Azure
O módulo `azure` exibe a assinatura Azure atual. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. O módulo `azure` exibe a assinatura Azure atual. Isto é baseado na exibição do nome da assinatura padrão ou no nome do usuário, como definido no arquivo `~/.azure/azureProfile.json`.
### Opções ### Opções
@ -621,14 +633,14 @@ O módulo `c` mostra algumas informações sobre o seu compilador de C. Por padr
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | A string de formato do módulo. | | `format` | `'via [$symbol($version(-$name) )]($style)'` | A string de formato do módulo. |
| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | O símbolo utilizado antes de exibir os detalhes do compilador | | `symbol` | `'C '` | O símbolo utilizado antes de exibir os detalhes do compilador |
| `detect_extensions` | `['c', 'h']` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `['c', 'h']` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | Como detectar qual é o compilador | | `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | Como detectar qual é o compilador |
| `style` | `'bold 149'` | O estilo do módulo. | | `style` | `'bold 149'` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `c`. | | `disabled` | `false` | Desabilita o módulo `c`. |
@ -671,7 +683,7 @@ O caractere vai te dizer se o ultimo comando foi bem sucedido ou não. Você pod
Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olhada [neste exemplo](#with-custom-error-shape). Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olhada [neste exemplo](#with-custom-error-shape).
::: warning ::: atenção
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `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).
@ -1137,6 +1149,47 @@ truncation_length = 8
truncation_symbol = '…/' 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`.
### Opções
| Opções | Padrão | Descrição |
| ------------------- | -------------------------------------- | ----------------------------------------------------- |
| `format` | `'[$symbol$loaded/$allowed]($style) '` | O formato do módulo. |
| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |
| `style` | `'bold orange'` | O estilo do módulo. |
| `disabled` | `true` | Disables the `direnv` module. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `['.envrc']` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `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. |
### Variáveis
| Variável | Exemplo | Descrição |
| --------- | ------------------- | --------------------------------------- |
| 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 | | Espelha o valor da opção `symbol`. |
| style\* | `red bold` | Espelha o valor da opção `style`. |
*: Esta variável só pode ser usada como parte de uma string de estilo
### Exemplo
```toml
# ~/.config/starship.toml
[direnv]
disabled = false
```
## Docker Context ## Docker Context
O módulo `docker_context` exibe o [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) ativo atualmente se não estiver definido como `default` ou se as variáveis de ambiente `DOCKER_MACHINE_NAME`, `DOCKER_HOST` ou `DOCKER_CONTEXT` estiverem definidas (iram sobrescrever o contexto atual). O módulo `docker_context` exibe o [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) ativo atualmente se não estiver definido como `default` ou se as variáveis de ambiente `DOCKER_MACHINE_NAME`, `DOCKER_HOST` ou `DOCKER_CONTEXT` estiverem definidas (iram sobrescrever o contexto atual).
@ -1435,7 +1488,7 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe
| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | O estilo do módulo. | | `style` | `'bold green'` | O estilo do módulo. |
| `detect_extensions` | `[fnl]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `['fnl']` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `disabled` | `false` | Disables the `fennel` module. | | `disabled` | `false` | Disables the `fennel` module. |
@ -1524,11 +1577,46 @@ truncation_length = 4
truncation_symbol = '' 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.
### Opções
| Opções | Padrão | Descrição |
| -------------------- | ------------------------------------------------------------ | ------------------------------------------- |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | O formato do módulo. |
| `added_style` | `'bold green'` | O estilo para a contagem de adições. |
| `deleted_style` | `'bold red'` | O estilo para a contagem de exclusões. |
| `only_nonzero_diffs` | `true` | Exibe apenas o status para itens alterados. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Variáveis
| Variável | Exemplo | Descrição |
| ----------------- | ------- | --------------------------------------- |
| added | `1` | O número atual de linhas adicionadas |
| deleted | `2` | O número atual de linhas excluidas |
| added_style\* | | Espelha o valor da opção `added_style` |
| deleted_style\* | | Espelha o valor da opção`deleted_style` |
*: Esta variável só pode ser usada como parte de uma string de estilo
### Exemplo
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
O módulo `gcloud` exibe a configuração atual para a CLI do [`gcloud`](https://cloud.google.com/sdk/gcloud). Isto é baseadp mp arquivo `~/.config/gcloud/active_config` e no arquivo`~/.config/gcloud/configurations/config_{CONFIG NAME}` e a env var `CLOUDSDK_CONFIG`. O módulo `gcloud` exibe a configuração atual para a CLI do [`gcloud`](https://cloud.google.com/sdk/gcloud). Isto é baseadp mp arquivo `~/.config/gcloud/active_config` e no arquivo`~/.config/gcloud/configurations/config_{CONFIG NAME}` e a env var `CLOUDSDK_CONFIG`.
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.
### Opções ### Opções
@ -1931,8 +2019,8 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------- | -------------------------- | ------------------------------------------------------ | | ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | O formato do módulo. | | `format` | `'via [$symbol]($style) '` | O formato do módulo. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | O estilo do módulo. | | `style` | `'yellow bold'` | O estilo do módulo. |
| `disabled` | `false` | Disables the `guix_shell` module. | | `disabled` | `false` | Disables the `guix_shell` module. |
### Variáveis ### Variáveis
@ -1969,13 +2057,13 @@ The `gradle` module is only able to read your Gradle Wrapper version from your c
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
| `version_format` | `"v${raw}"` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `['gradle', 'gradle.kts']` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `["gradle"]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `['gradle']` | Quais pastas devem ativar este módulo. |
| `style` | `"bold bright-cyan"` | O estilo do módulo. | | `style` | `'bold bright-cyan'` | O estilo do módulo. |
| `disabled` | `false` | Disables the `gradle` module. | | `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | | `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
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
| `version_format` | `"v${raw}"` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["hx", "hxml"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `['hx', 'hxml']` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `['.haxelib', 'haxe_libraries']` | Quais pastas devem ativar este módulo. |
| `symbol` | `"⌘ "` | O formato de string que representa o simbolo do Helm. | | `symbol` | `'⌘ '` | O formato de string que representa o simbolo do Helm. |
| `style` | `"bold fg:202"` | O estilo do módulo. | | `style` | `'bold fg:202'` | O estilo do módulo. |
| `disabled` | `false` | Disables the `haxe` module. | | `disabled` | `false` | Disables the `haxe` module. |
### Variáveis ### Variáveis
@ -2108,10 +2196,11 @@ O módulo `hostname` exibe o nome do hostname.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Apenas exibe o hostname quando conectado em uma sessão SSH. | | `ssh_only` | `true` | Apenas exibe o hostname quando conectado em uma sessão SSH. |
| `ssh_symbol` | `'🌐 '` | Uma formatação de string que representa o símbolo quando conectado à sessão SSH. | | `ssh_symbol` | `'🌐 '` | Uma formatação de string que representa o símbolo quando conectado à sessão SSH. |
| `trim_at` | `'.'` | String na qual vai truncar o hostname, após a primeira correspondência. `'.'` will stop after the first dot. `''` will disable any truncation | | `trim_at` | `'.'` | String na qual vai truncar o hostname, após a primeira correspondência. `'.'` 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 '` | O formato do módulo. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | O formato do módulo. |
| `style` | `'bold dimmed green'` | O estilo do módulo. | | `style` | `'bold dimmed green'` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `hostname`. | | `disabled` | `false` | Desabilita o módulo `hostname`. |
@ -2126,7 +2215,9 @@ O módulo `hostname` exibe o nome do hostname.
*: Esta variável só pode ser usada como parte de uma string de estilo *: Esta variável só pode ser usada como parte de uma string de estilo
### Exemplo ### Exemplos
#### Always show the hostname
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -2138,6 +2229,17 @@ trim_at = '.companyname.com'
disabled = false 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 ## Java
O módulo `java` exibe o versão atual instalada do [Java](https://www.oracle.com/java/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: O módulo `java` exibe o versão atual instalada do [Java](https://www.oracle.com/java/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
@ -2323,7 +2425,7 @@ kotlin_binary = 'kotlinc'
## Kubernetes ## Kubernetes
Exibe o nome atual do [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) e, se definido, o namespace, usuário e cluster do arquivo kubeconfig. O namespace precisa ser definido no arquivo kubeconfig, isso pode ser feito via `kubectl config set-context starship-context --namespace astronaut`. Da mesma forma, o usuário e o cluster podem ser definidos com `kubectl config set-context starship-context --user starship-user` e `kubectl config set-context starship-context --cluster starship-cluster`. Se a env var `$KUBECONFIG` estiver definida o módulo vai usa-la ao invés de usar o `~/.kube/config`. Exibe o nome atual do [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) e, se definido, o namespace, usuário e cluster do arquivo kubeconfig. O namespace precisa ser definido no arquivo kubeconfig, isso pode ser feito via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Se a env var `$KUBECONFIG` estiver definida o módulo vai usa-la ao invés de usar o `~/.kube/config`.
::: tip ::: tip
@ -2335,18 +2437,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
### Opções ### Opções
::: atenção
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ---------------------------------------------------- | ------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | ------------------------------------------------------------- |
| `symbol` | `'☸ '` | Uma string que representa o simbolo exibido antes do Cluster. | | `symbol` | `'☸ '` | Uma string que representa o simbolo exibido antes do Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | O formato do módulo. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | O formato do módulo. |
| `style` | `'cyan bold'` | O estilo do módulo. | | `style` | `'cyan bold'` | O estilo do módulo. |
| `context_aliases` | `{}` | Tabela de aliases de contexto para exibir. | | `context_aliases`* | `{}` | Tabela de aliases de contexto para exibir. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Desabilita o módulo `kubernetes`. | | `disabled` | `true` | Desabilita o módulo `kubernetes`. |
*: 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:
| Variável | Descrição |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `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. |
| `symbol` | 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)).
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
@ -2368,13 +2492,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
[kubernetes] [kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] contexts = [
'dev.local.cluster.k8s' = 'dev' { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
'.*/openshift-cluster/.*' = 'openshift' ]
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'
``` ```
Only show the module in directories that contain a `k8s` file. Only show the module in directories that contain a `k8s` file.
@ -2387,25 +2507,36 @@ disabled = false
detect_files = ['k8s'] detect_files = ['k8s']
``` ```
#### Correspondência Regex #### Kubernetes Context specific config
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming 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.
A expressão regular deve coincidir com todo o contexto kube, Grupos de captura podem ser referenciados usando `$name` e `$N` na substituição. Isto esta mais explicado na documentação do [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace).
Nomes longos de clusters gerados automaticamente podem ser encurtados usando expressão regular:
```toml ```toml
[kubernetes.context_aliases] # ~/.config/starship.toml
# 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'
[[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. # 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`) # 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`): # 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"
``` ```
## Quebra de Linha ## Quebra de Linha
@ -2730,7 +2861,7 @@ O módulo `nodejs` exibe a versão atual instalada do [Node.js](https://nodejs.o
| `detect_folders` | `['node_modules']` | Quais pastas devem ativar este módulo. | | `detect_folders` | `['node_modules']` | Quais pastas devem ativar este módulo. |
| `style` | `'bold green'` | O estilo do módulo. | | `style` | `'bold green'` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `nodejs`. | | `disabled` | `false` | Desabilita o módulo `nodejs`. |
| `not_capable_style` | `bold red` | O estilo para o módulo quando a propriedade engine no package.json não coincide com a versão do Node.js. | | `not_capable_style` | `'bold red'` | O estilo para o módulo quando a propriedade engine no package.json não coincide com a versão do Node.js. |
### Variáveis ### Variáveis
@ -2890,8 +3021,8 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------- | --------------------- | ------------------------------------------------------ | | ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | O formato do módulo. | | `format` | `'[$symbol]($style)'` | O formato do módulo. |
| `style` | `"bold white"` | O estilo do módulo. | | `style` | `'bold white'` | O estilo do módulo. |
| `disabled` | `true` | Disables the `os` module. | | `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. | | `symbols` | | A table that maps each operating system to its symbol. |
@ -3150,10 +3281,10 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------------- | ---------- | --------------------------------- | | --------- | ---------- | --------------------------------- |
| version | `v0.12.24` | A versão do `pulumi` | | version | `v0.12.24` | A versão do `pulumi` |
| stack | `dev` | A stack Pulumi atual | | stack | `dev` | A stack Pulumi atual |
| nome do usuário | `alice` | O nome de usuário Pulumi atual | | username | `alice` | O nome de usuário Pulumi atual |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3245,7 +3376,7 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
| `symbol` | `'🐍 '` | Uma string que representa o simbolo do Python | | `symbol` | `'🐍 '` | Uma string que representa o simbolo do Python |
| `style` | `'yellow bold'` | O estilo do módulo. | | `style` | `'yellow bold'` | O estilo do módulo. |
| `pyenv_version_name` | `false` | Usa pyenv para pegar a versão do Python | | `pyenv_version_name` | `false` | Usa pyenv para pegar a versão do Python |
| `pyenv_prefix` | `pyenv` | Prefixo antes da versão do pyenv, apenas usado se pyenv for usado | | `pyenv_prefix` | `'pyenv'` | Prefixo antes da versão do pyenv, apenas usado se pyenv for usado |
| `python_binary` | `['python', 'python3', 'python2']` | Configura o binário python que o Starship vai executar para obter a versão. | | `python_binary` | `['python', 'python3', 'python2']` | Configura o binário python que o Starship vai executar para obter a versão. |
| `detect_extensions` | `['py']` | Quais extensões devem acionar este módulo | | `detect_extensions` | `['py']` | Quais extensões devem acionar este módulo |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | [] | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | [] |
@ -3563,11 +3694,12 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------------------- | ------------------------- | ------------------------------------------------------- | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | Uma string para representar o bash. | | `bash_indicator` | `'bsh'` | Uma string para representar o bash. |
| `fish_indicator` | `'fsh'` | Uma string usada para representar o fish. | | `fish_indicator` | `'fsh'` | Uma string usada para representar o fish. |
| `zsh_indicator` | `'zsh'` | Uma string usada para representar o zsh. | | `zsh_indicator` | `'zsh'` | Uma string usada para representar o zsh. |
| `powershell_indicator` | `'psh'` | Uma string usada para representar o powershell. | | `powershell_indicator` | `'psh'` | Uma string usada para representar o powershell. |
| `pwsh_indicator` | | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. |
| `ion_indicator` | `'ion'` | Uma string usada para representar o ion. | | `ion_indicator` | `'ion'` | Uma string usada para representar o ion. |
| `elvish_indicator` | `'esh'` | Uma string usada para representar o elvish. | | `elvish_indicator` | `'esh'` | Uma string usada para representar o elvish. |
| `tcsh_indicator` | `'tsh'` | Uma string usada para representar o tcsh. | | `tcsh_indicator` | `'tsh'` | Uma string usada para representar o tcsh. |
@ -3694,14 +3826,14 @@ The `solidity` module shows the currently installed version of [Solidity](https:
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
| `version_format` | `"v${major}.${minor}.${patch}"` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${major}.${minor}.${patch}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity | | `symbol` | `'S '` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. | | `compiler | ['solc'] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `['sol']` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold blue"` | O estilo do módulo. | | `style` | `'bold blue'` | O estilo do módulo. |
| `disabled` | `false` | Disables this module. | | `disabled` | `false` | Disables this module. |
### Variáveis ### Variáveis
@ -4009,6 +4141,39 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Typst
The `typst` module shows the current installed version of Typst used in a project.
Por padrão, o módulo será exibido se qualquer das seguintes condições for atendida:
- O diretório atual conter um arquivo `template.typ`
- The current directory contains any `*.typ` file
### Opções
| Opções | Padrão | Descrição |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'t '` | A format string representing the symbol of Daml |
| `style` | `'bold #0093A7'` | O estilo do módulo. |
| `detect_extensions` | `['.typ']` | Quais extensões devem ativar este módulo. |
| `detect_files` | `['template.typ']` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `disabled` | `false` | Disables the `daml` module. |
### Variáveis
| Variável | Exemplo | Descrição |
| ------------- | --------- | ----------------------------------------------- |
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
| typst_version | `default` | The current Typst version |
| symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` |
*: Esta variável só pode ser usada como parte de uma string de estilo
## Nome do usuário ## Nome do usuário
O módulo `username` mostra o nome de usuário do usuário ativo. O módulo será mostrado se alguma das seguintes condições for atendida: O módulo `username` mostra o nome de usuário do usuário ativo. O módulo será mostrado se alguma das seguintes condições for atendida:

8
docs/pt-BR/guide/README.md
View File

@ -32,6 +32,11 @@
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Siga o @StarshipPrompt no Twitter" alt="Siga o @StarshipPrompt no Twitter"
/></a> /></a>
<a href="https://stand-with-ukraine.pp.ua"
><img
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
alt="Stand With Ukraine"
/></a>
</p> </p>
<p align="center"> <p align="center">
@ -147,8 +152,6 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
<img <img
@ -229,6 +232,7 @@ Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` | | Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` | | Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
</details> </details>

Some files were not shown because too many files have changed in this diff Show More