Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 03:27:30 +00:00
Code Issues Releases Activity

docs(i18n): new Crowdin updates (#5109)

Browse Source
This commit is contained in:
Matan Kushner 2023-06-06 10:10:23 -04:00 committed by GitHub
parent e703d86b7e
commit 9bebd0e280
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
78 changed files with 2702 additions and 1202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ar-SA/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| Variable | الافتراضي | الوصف | | Variable | الافتراضي | الوصف |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. | | `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. | | `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Variable | مثال | الوصف | | Variable | مثال | الوصف |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | مثال | الوصف | | Variable | مثال | الوصف |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | الافتراضي | الوصف |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | مثال | الوصف |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### مثال
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4162,7 +4229,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `الوصف` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ curl -sS https://starship.rs/install.sh | sh
</details> </details>
### الخطوة الثانية. قم بإعداد ال shell الخاص بك ### الخطوة الثانية. Set up your shell to use Starship
لإعداد ال starship قم بإعداد ال shell الخاص بك. اختر ما يناسبك من هذه القائمة: لإعداد ال starship قم بإعداد ال shell الخاص بك. اختر ما يناسبك من هذه القائمة:

2
docs/ckb-IR/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| گۆڕاو | Default | Description | | گۆڕاو | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description | | Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. | | `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. | | `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| گۆڕاو | نموونە | Description |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### نموونە
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.

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

@ -108,6 +108,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -259,7 +267,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Step 2. Setup your shell to use Starship ### Step 2. Set up your shell to use Starship
Configure your shell to initialize starship. Select yours from the list below: Configure your shell to initialize starship. Select yours from the list below:

2
docs/de-DE/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Optionen ### Optionen
| Variable | Standartwert | Beschreibung | | Variable | Standartwert | Beschreibung |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Beispiele ### Beispiele
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Akkustand ## Akkustand
Das `battery` Modul zeigt, wie hoch der Akku des Geräts geladen ist und den aktuellen Ladestatus. Das Modul ist nur sichtbar, wenn der Akku des Geräts unter 10% geladen ist. Das `battery` Modul zeigt, wie hoch der Akku des Geräts geladen ist und den aktuellen Ladestatus. Das Modul ist nur sichtbar, wenn der Akku des Geräts unter 10% geladen ist.
@ -467,11 +478,11 @@ Das `battery` Modul zeigt, wie hoch der Akku des Geräts geladen ist und den akt
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| -------------------- | --------------------------------- | ----------------------------------------------------------------------------------- | | -------------------- | --------------------------------- | ----------------------------------------------------------------------------------- |
| `full_symbol` | `' '` | Das Symbol das angezeigt wird wenn der Akku voll geladen ist. | | `full_symbol` | `'󰁹 '` | Das Symbol das angezeigt wird wenn der Akku voll geladen ist. |
| `charging_symbol` | `' '` | Das Symbol das angezeigt wird wenn der Akku aufgeladen wird. | | `charging_symbol` | `'󰂄 '` | Das Symbol das angezeigt wird wenn der Akku aufgeladen wird. |
| `discharging_symbol` | `' '` | Das Symbol, das angezeigt wird, wenn die Batterie entladen wird. | | `discharging_symbol` | `'󰂃 '` | Das Symbol, das angezeigt wird, wenn die Batterie entladen wird. |
| `unknown_symbol` | `' '` | Das Symbol, das angezeigt wird, wenn der Batteriezustand unbekannt ist. | | `unknown_symbol` | `'󰁽 '` | Das Symbol, das angezeigt wird, wenn der Batteriezustand unbekannt ist. |
| `empty_symbol` | `' '` | Das Symbol, das angezeigt wird, wenn die Batterie leer ist. | | `empty_symbol` | `'󰂎 '` | Das Symbol, das angezeigt wird, wenn die Batterie leer ist. |
| `format` | `'[$symbol$percentage]($style) '` | Das Format für das Modul. | | `format` | `'[$symbol$percentage]($style) '` | Das Format für das Modul. |
| `display` | [link](#battery-display) | Stellt den Grenzwert ein ab dem der Ladezustand (das battery-Modul) angezeigt wird. | | `display` | [link](#battery-display) | Stellt den Grenzwert ein ab dem der Ladezustand (das battery-Modul) angezeigt wird. |
| `disabled` | `false` | Wenn der Wert auf `true` steht, wird das Akkustand-Modul deaktiviert. | | `disabled` | `false` | Wenn der Wert auf `true` steht, wird das Akkustand-Modul deaktiviert. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Stil für dieses Modul. | | `style` | `'bold blue'` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Das Format für das Modul. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Das Format für das Modul. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Stil für dieses Modul. | | `style` | `'bold red'` | Stil für dieses Modul. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Deaktiviert das `git_status`-Modul. | | `disabled` | `false` | Deaktiviert das `git_status`-Modul. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Spiegelt den Wert der Option `style` | | style\* | Spiegelt den Wert der Option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Optionen ### Optionen
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | Stil für dieses Modul. | | `style` | `'bold cyan'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `golang`-Modul. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Deaktiviert das `golang`-Modul. |
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | --------- | ------------------------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Spiegelt den Wert der Option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Spiegelt den Wert der Option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | ---------- | ------------------------------------- | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Spiegelt den Wert der Option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Spiegelt den Wert der Option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Optionen
| Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Beispiel
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4162,7 +4229,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `beschreibung` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Schritt 2. Richte deine Shell für die Nutzung von Starship ein ### Schritt 2. Set up your shell to use Starship
Konfigurieren deine Shell um Starship zu initialisieren. Wähle dafür deine Shell aus der Liste aus: Konfigurieren deine Shell um Starship zu initialisieren. Wähle dafür deine Shell aus der Liste aus:

2
docs/es-ES/advanced-config/README.md
View File

@ -193,7 +193,7 @@ También puede establecer una salida similar con PowerShell creando una función
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

177
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 | Type | Notes | | Symbol | Tipo | Notas |
| ------ | ------------------------- | ------------------------------------------------------ | | ------ | ------------------------- | ------------------------------------------------------ |
| `'` | literal string | less escaping | | `'` | literal string | less escaping |
| `"` | string | more escaping | | `"` | string | more escaping |
@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
El módulo `aws` muestra la región y el perfil actual de AWS y un temporizador de vencimiento cuando se utilizan credenciales temporales. La salida del módulo utiliza las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION` y `AWS_PROFILE`, y los archivos `~/. ws/config` y `~/.aws/credenciales` según sea necesario. El módulo `aws` muestra la región y el perfil actual de AWS y un temporizador de vencimiento cuando se utilizan credenciales temporales. La salida del módulo utiliza las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION` y `AWS_PROFILE`, y los archivos `~/. ws/config` y `~/.aws/credenciales` según sea necesario.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
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`.
@ -426,12 +427,13 @@ El módulo `azure` muestra la suscripción Azure actual. This is based on showin
### Opciones ### Opciones
| Variable | Predeterminado | Descripción | | Variable | Predeterminado | Descripción |
| ---------- | ---------------------------------------- | ------------------------------------------- | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | El formato para renderizar el módulo Azure. | | `format` | `'on [$symbol($subscription)]($style) '` | El formato para renderizar el módulo Azure. |
| `symbol` | `'ﴃ '` | El símbolo utilizado en el formato. | | `symbol` | `'󰠅 '` | El símbolo utilizado en el formato. |
| `style` | `'blue bold'` | El estilo utilizado en el formato. | | `style` | `'blue bold'` | El estilo utilizado en el formato. |
| `disabled` | `true` | Deshabilita el módulo `azure`. | | `disabled` | `true` | Deshabilita el módulo `azure`. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Ejemplos ### Ejemplos
@ -443,7 +445,7 @@ El módulo `azure` muestra la suscripción Azure actual. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
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 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%.
@ -467,11 +478,11 @@ El módulo `battery` muestra la cantidad de batería y si se está cargando o no
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| -------------------- | --------------------------------- | ------------------------------------------------------------------------ | | -------------------- | --------------------------------- | ------------------------------------------------------------------------ |
| `full_symbol` | `' '` | Se muestra cuando la batería está cargada. | | `full_symbol` | `'󰁹 '` | Se muestra cuando la batería está cargada. |
| `charging_symbol` | `' '` | Se muestra cuando la batería se está cargando. | | `charging_symbol` | `'󰂄 '` | Se muestra cuando la batería se está cargando. |
| `discharging_symbol` | `' '` | Se muestra cuando la batería se está descargando. | | `discharging_symbol` | `'󰂃 '` | Se muestra cuando la batería se está descargando. |
| `unknown_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería es desconocido. | | `unknown_symbol` | `'󰁽 '` | El símbolo que se muestra cuando el estado de la batería es desconocido. |
| `empty_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería está vacío. | | `empty_symbol` | `'󰂎 '` | El símbolo que se muestra cuando el estado de la batería está vacío. |
| `format` | `'[$symbol$percentage]($style) '` | El formato del módulo. | | `format` | `'[$symbol$percentage]($style) '` | El formato del módulo. |
| `display` | [ver aquí](#battery-display) | Define cuándo mostrar el indicador y el estilo. | | `display` | [ver aquí](#battery-display) | Define cuándo mostrar el indicador y el estilo. |
| `disabled` | `false` | Desactiva el módulo `battery`. | | `disabled` | `false` | Desactiva el módulo `battery`. |
@ -1336,7 +1347,7 @@ default = 'unknown user'
| `variable` | | La variable de entorno a mostrar. | | `variable` | | La variable de entorno a mostrar. |
| `default` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. | | `default` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. |
| `format` | `"con [$env_value]($style) "` | El formato del módulo. | | `format` | `"con [$env_value]($style) "` | El formato del módulo. |
| `descripción` | `"<env_var module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. | | `description` | `"<env_var module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. |
| `disabled` | `false` | Deshabilita el módulo `env_var`. | | `disabled` | `false` | Deshabilita el módulo `env_var`. |
### Variables ### Variables
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
@ -1525,6 +1538,7 @@ El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](h
| `symbol` | `'☁️ '` | El símbolo usado antes de mostrar el perfil actual de GCP. | | `symbol` | `'☁️ '` | El símbolo usado antes de mostrar el perfil actual de GCP. |
| `region_aliases` | `{}` | Tabla de alias de región a mostrar además del nombre GCP. | | `region_aliases` | `{}` | Tabla de alias de región a mostrar además del nombre GCP. |
| `project_aliases` | `{}` | Tabla de alias del proyecto a mostrar además del nombre GCP. | | `project_aliases` | `{}` | Tabla de alias del proyecto a mostrar además del nombre GCP. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | El estilo del módulo. | | `style` | `'bold blue'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `gcloud`. | | `disabled` | `false` | Deshabilita el módulo `gcloud`. |
@ -1724,6 +1738,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| `only_nonzero_diffs` | `true` | Mostrar sólo el estado de los elementos cambiados. | | `only_nonzero_diffs` | `true` | Mostrar sólo el estado de los elementos cambiados. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | El formato del módulo. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | El formato del módulo. |
| `disabled` | `true` | Deshabilita el módulo `git_metrics`. | | `disabled` | `true` | Deshabilita el módulo `git_metrics`. |
| `ignore_submodules` | `false` | Ignorar cambios a los submódulos |
### Variables ### Variables
@ -1772,6 +1787,7 @@ El módulo Git Status es muy lento en los directorios de Windows (por ejemplo ba
| `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` | | `borrado` | `'✘'` | El formato de `deleted` |
| `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. |
| `disabled` | `false` | Deshabilita el módulo `git_status`. | | `disabled` | `false` | Deshabilita el módulo `git_status`. |
@ -1792,6 +1808,7 @@ Las siguientes variables se pueden utilizar en `format`:
| `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. | | `borrado` | 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. |
| style\* | Refleja el valor de la opción `style` | | style\* | Refleja el valor de la opción `style` |
*: 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
@ -1864,24 +1881,26 @@ El módulo `golang` muestra la versión instalada de [Go](https://golang.org/).
### Opciones ### Opciones
| 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` | `'🐹 '` | Una cadena de formato que representa el símbolo de Go. | | `symbol` | `'🐹 '` | Una cadena de formato que representa el símbolo de Go. |
| `detect_extensions` | `['go']` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `['go']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `['Godeps']` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `['Godeps']` | Qué carpetas deberían activar este módulo. |
| `style` | `'bold cyan'` | El estilo del módulo. | | `style` | `'bold cyan'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo de `golang`. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Deshabilita el módulo de `golang`. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | --------- | -------------------------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | La versión de `go` | | version | `v1.12.1` | La versión de `go` |
| symbol | | Refleja el valor de la opción `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Refleja el valor de la opción `style` | | 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 *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
@ -1894,6 +1913,15 @@ El módulo `golang` muestra la versión instalada de [Go](https://golang.org/).
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ El módulo `nodejs` muestra la versión instalada de [Node.js](https://nodejs.or
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ---------- | -------------------------------------- | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | La versión de `node` | | version | `v13.12.0` | La versión de `node` |
| symbol | | Refleja el valor de la opción `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Refleja el valor de la opción `style` | | 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 *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
@ -3565,7 +3594,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ El módulo `singularity` muestra la imagen de [singularity](https://sylabs.io/si
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Opciones
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Ejemplo
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.io/en/latest/), si `$SPACK_ENV` está configurado. El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.io/en/latest/), si `$SPACK_ENV` está configurado.
@ -3707,7 +3774,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| -------------- | ------- | ------------------------------------------------------------------------------------------ | | -------------- | ------- | ------------------------------------------------------------------------------------------ |
| status | `127` | El código de salida del último comando | | estado | `127` | El código de salida del último comando |
| hex_status | `0x7F` | El código de salida del último comando en hexadecimal | | hex_status | `0x7F` | El código de salida del último comando en hexadecimal |
| int | `127` | El código de salida del último comando | | int | `127` | El código de salida del último comando |
| common_meaning | `ERROR` | Comprobación del código si no es una señal | | common_meaning | `ERROR` | Comprobación del código si no es una señal |
@ -4156,23 +4223,23 @@ Las cadenas de formato también pueden contener secuencias específicas del int
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `comando` | `''` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. | | `comando` | `''` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. |
| `cuando` | `false` | Valor booleano (`true` o `false`, sin comillas) o un comando de shell usado como una condición para mostrar el módulo. En caso de una cadena, el módulo se mostrará si el comando devuelve un código de estado `0`. | | `cuando` | `false` | Valor booleano (`true` o `false`, sin comillas) o un comando de shell usado como una condición para mostrar el módulo. En caso de una cadena, el módulo se mostrará si el comando devuelve un código de estado `0`. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [Ver a continuación](#custom-command-shell) | | `shell` | | [Ver a continuación](#custom-command-shell) |
| `descripción` | `'<custom module>'` | La descripción del módulo que se muestra al ejecutar `starship explain`. | | `description` | `'<módulo personalizado>'` | La descripción del módulo que se muestra al ejecutar `starship explain`. |
| `detect_files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. | | `detect_files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. |
| `detect_folders` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. | | `detect_folders` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. |
| `detect_extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. | | `detect_extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. |
| `symbol` | `''` | El símbolo usado antes de mostrar la salida del comando. | | `symbol` | `''` | El símbolo usado antes de mostrar la salida del comando. |
| `style` | `'bold green'` | El estilo del módulo. | | `style` | `'bold green'` | El estilo del módulo. |
| `format` | `'[$symbol($output )]($style)'` | El formato del módulo. | | `format` | `'[$symbol($output )]($style)'` | El formato del módulo. |
| `disabled` | `false` | Deshabilita este módulo `custom`. | | `disabled` | `false` | Deshabilita este módulo `custom`. |
| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | Un valor booleano opcional que anula si los comandos deben ser reenviados al shell a través de la entrada estándar o como argumento. Si la entrada estándar unset es usada de manera predeterminada, a menos que el shell no lo soporte (cmd, nushell). Configurar esto desactiva el manejo de argumentos específicos del shell. | | `use_stdin` | | Un valor booleano opcional que anula si los comandos deben ser reenviados al shell a través de la entrada estándar o como argumento. Si la entrada estándar unset es usada de manera predeterminada, a menos que el shell no lo soporte (cmd, nushell). Configurar esto desactiva el manejo de argumentos específicos del shell. |
| `ignore_timeout` | `false` | Ignorar la configuración global de `command_timeout` y seguir ejecutando comandos externos, sin importar el tiempo que tarden. | | `ignore_timeout` | `false` | Ignorar la configuración global de `command_timeout` y seguir ejecutando comandos externos, sin importar el tiempo que tarden. |
### Variables ### Variables

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -119,7 +127,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
alt="Tiếng Việt" alt="Vietnamita"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -127,7 +135,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
alt="简体中文" alt="Chino Mandarín"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -135,7 +143,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
alt="繁體中文" alt="Chino Tradicional"
/></a> /></a>
</p> </p>
@ -263,7 +271,7 @@ Instalar Starship usando cualquiera de los siguientes gestores de paquetes:
</details> </details>
### Paso 2. Configura tu shell para usar Starship ### Paso 2. Set up your shell to use Starship
Configure su shell para inicializar starship. Selecciona el tuyo de la lista de abajo: Configure su shell para inicializar starship. Selecciona el tuyo de la lista de abajo:

2
docs/fr-FR/advanced-config/README.md
View File

@ -193,7 +193,7 @@ Vous pouvez également faire la même chose avec PowerShell en créant une fonct
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
Lorsque vous utilisez [aws-vault](https://github.com/99designs/aws-vault) le profil est lu à partir de la variable d'environnement `AWS_VAULT` et la date d'expiration des identifiants est lue à partir de la variable d'environnement `AWS_SESSION_EXPIRATION`. Lorsque vous utilisez [aws-vault](https://github.com/99designs/aws-vault) le profil est lu à partir de la variable d'environnement `AWS_VAULT` et la date d'expiration des identifiants est lue à partir de la variable d'environnement `AWS_SESSION_EXPIRATION`.
@ -426,12 +427,13 @@ Le module `azure` affiche l'abonnement Azure actuel. This is based on showing th
### Options ### Options
| Variable | Défaut | Description | | Variable | Défaut | Description |
| ---------- | ---------------------------------------- | ---------------------------------------- | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | Le format pour le rendu du module Azure. | | `format` | `'on [$symbol($subscription)]($style) '` | Le format pour le rendu du module Azure. |
| `symbole` | `'ﴃ '` | Le symbole utilisé dans le format. | | `symbole` | `'󰠅 '` | Le symbole utilisé dans le format. |
| `style` | `'blue bold'` | Le style utilisé dans le format. | | `style` | `'blue bold'` | Le style utilisé dans le format. |
| `disabled` | `true` | Désactive le module `azure`. | | `disabled` | `true` | Désactive le module `azure`. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Exemples ### Exemples
@ -443,7 +445,7 @@ Le module `azure` affiche l'abonnement Azure actuel. This is based on showing th
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
Le module `battery` montre à quel point la batterie de l'appareil est chargée et son état de charge actuel. Ce module n'est visible que lorsque la batterie de l'appareil est inférieure à 10%. Le module `battery` montre à quel point la batterie de l'appareil est chargée et son état de charge actuel. Ce module n'est visible que lorsque la batterie de l'appareil est inférieure à 10%.
@ -467,11 +478,11 @@ Le module `battery` montre à quel point la batterie de l'appareil est chargée
| Option | Défaut | Description | | Option | Défaut | Description |
| -------------------- | --------------------------------- | ------------------------------------------------------------- | | -------------------- | --------------------------------- | ------------------------------------------------------------- |
| `full_symbol` | `' '` | Le symbole affiché lorsque la batterie est pleine. | | `full_symbol` | `'󰁹 '` | Le symbole affiché lorsque la batterie est pleine. |
| `charging_symbol` | `' '` | Le symbole affiché lorsque la batterie se charge. | | `charging_symbol` | `'󰂄 '` | Le symbole affiché lorsque la batterie se charge. |
| `discharging_symbol` | `' '` | Le symbole affiché lorsque la batterie se décharge. | | `discharging_symbol` | `'󰂃 '` | Le symbole affiché lorsque la batterie se décharge. |
| `unknown_symbol` | `' '` | Le symbole affiché lorsque l'état de la batterie est inconnu. | | `unknown_symbol` | `'󰁽 '` | Le symbole affiché lorsque l'état de la batterie est inconnu. |
| `empty_symbol` | `' '` | Le symbole affiché lorsque la batterie est vide. | | `empty_symbol` | `'󰂎 '` | Le symbole affiché lorsque la batterie est vide. |
| `format` | `'[$symbol$percentage]($style) '` | Format du module. | | `format` | `'[$symbol$percentage]($style) '` | Format du module. |
| `display` | [lien](#battery-display) | Affiche le seuil et le style du module. | | `display` | [lien](#battery-display) | Affiche le seuil et le style du module. |
| `disabled` | `false` | Désactive le module `battery`. | | `disabled` | `false` | Désactive le module `battery`. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
@ -1525,6 +1538,7 @@ Le module `gcloud` affiche la version de la commande [`gcloud`](https://cloud.go
| `symbole` | `'☁️ '` | Le symbole affiché avant le profil GCP actuel. | | `symbole` | `'☁️ '` | Le symbole affiché avant le profil GCP actuel. |
| `region_aliases` | `{}` | Table des alias de région à afficher en plus du nom du GCP. | | `region_aliases` | `{}` | Table des alias de région à afficher en plus du nom du GCP. |
| `project_aliases` | `{}` | Table des alias de projet à afficher en plus du nom du GCP. | | `project_aliases` | `{}` | Table des alias de projet à afficher en plus du nom du GCP. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Le style pour le module. | | `style` | `'bold blue'` | Le style pour le module. |
| `disabled` | `false` | Désactive le module `gcloud`. | | `disabled` | `false` | Désactive le module `gcloud`. |
@ -1724,6 +1738,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
| `only_nonzero_diffs` | `true` | Afficher le statut seulement pour les items modifiés. | | `only_nonzero_diffs` | `true` | Afficher le statut seulement pour les items modifiés. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format du module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format du module. |
| `disabled` | `true` | Désactive le module `git_metrics`. | | `disabled` | `true` | Désactive le module `git_metrics`. |
| `ignore_submodules` | `false` | Ignorer les changements des sous-modules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ Le module Statut Git est très lent dans les dossiers Windows (par exemple sous
| `staged` | `'+'` | Le format de `staged` | | `staged` | `'+'` | Le format de `staged` |
| `renamed` | `'»'` | Le format de `renamed` | | `renamed` | `'»'` | Le format de `renamed` |
| `deleted` | `'✘'` | Le format de `deleted` | | `deleted` | `'✘'` | Le format de `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Le style pour le module. | | `style` | `'bold red'` | Le style pour le module. |
| `ignore_submodules` | `false` | Ignorer les changements des sous-modules. | | `ignore_submodules` | `false` | Ignorer les changements des sous-modules. |
| `disabled` | `false` | Désactive le module `git_status`. | | `disabled` | `false` | Désactive le module `git_status`. |
@ -1792,6 +1808,7 @@ Les variables suivantes peuvent être utilisées pour la valeur de `format`:
| `staged` | Affiche `staged` lorsqu'un nouveau fichier a été ajouté à la zone de validation. | | `staged` | Affiche `staged` lorsqu'un nouveau fichier a été ajouté à la zone de validation. |
| `renamed` | Affiche `renamed` lorsqu'un fichier renommé a été ajouté à la zone de validation. | | `renamed` | Affiche `renamed` lorsqu'un fichier renommé a été ajouté à la zone de validation. |
| `deleted` | Affiche `deleted` lorsque la suppression d'un fichier a été ajoutée à la zone de validation. | | `deleted` | Affiche `deleted` lorsque la suppression d'un fichier a été ajoutée à la zone de validation. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Reflète la valeur de l'option `style` | | style\* | Reflète la valeur de l'option `style` |
*: Cette variable peut uniquement être utilisée dans une chaine de style *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -1864,24 +1881,26 @@ Le module `golang` affiche la version de [Go](https://golang.org/) installée. P
### Options ### Options
| 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` | `'🐹 '` | Une chaîne de caractères représentant le symbole de Go. | | `symbole` | `'🐹 '` | Une chaîne de caractères représentant le symbole de Go. |
| `detect_extensionsdetect_extensions` | `['go']` | Les extensions qui déclenchent ce module. | | `detect_extensionsdetect_extensions` | `['go']` | Les extensions qui déclenchent ce module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Les fichiers qui activent ce module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Les fichiers qui activent ce module. |
| `detect_folders` | `['Godeps']` | Les dossiers qui activent ce module. | | `detect_folders` | `['Godeps']` | Les dossiers qui activent ce module. |
| `style` | `'bold cyan'` | Le style pour le module. | | `style` | `'bold cyan'` | Le style pour le module. |
| `disabled` | `false` | Désactive le module `golang`. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Désactive le module `golang`. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | --------- | -------------------------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | La version de `go` | | version | `v1.12.1` | La version de `go` |
| symbole | | Reflète la valeur de l'option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Reflète la valeur de l'option `style` | | 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 *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -1894,6 +1913,15 @@ Le module `golang` affiche la version de [Go](https://golang.org/) installée. P
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ Le module `nodejs` affiche la version de [Node.js](https://nodejs.org/) install
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ---------- | -------------------------------------- | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | La version de `node` | | version | `v13.12.0` | La version de `node` |
| symbole | | Reflète la valeur de l'option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Reflète la valeur de l'option `style` | | 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 *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -3566,7 +3595,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3641,6 +3670,44 @@ Le module `singularity` affiche l’image [Singularity](https://sylabs.io/singul
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Défaut | Description |
| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `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` |
| `symbole` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensionsdetect_extensions` | `["sol"]` | Les extensions qui déclenchent ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"bold blue"` | Le style pour le module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Exemple
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
Le module `spack` affiche l’environnement [Spack](https://spack.readthedocs.io/en/latest/) courant, si `$SPACK_ENV` est définie. Le module `spack` affiche l’environnement [Spack](https://spack.readthedocs.io/en/latest/) courant, si `$SPACK_ENV` est définie.

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Installez Starship en utilisant l’un de ces gestionnaires de paquets:
</details> </details>
### Étape 2. Configurer votre shell pour Starship ### Étape 2. Set up your shell to use Starship
Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous: Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous:

2
docs/id-ID/README.md
View File

@ -10,7 +10,7 @@ features:
title: Kompatibilitas Yang Utama title: Kompatibilitas Yang Utama
details: Dapat berfungsi di shells standar dengan sistem operasi yang paling biasa. Pakai di mana saja! details: Dapat berfungsi di shells standar dengan sistem operasi yang paling biasa. Pakai di mana saja!
- -
title: Dibangun Dengan Rust title: Dibuat dengan Rust
details: Menggunakan kecepatan dan keamanan dari Rust, untuk membuat prompt kamu bekerja secepat dan seandal mungkin. details: Menggunakan kecepatan dan keamanan dari Rust, untuk membuat prompt kamu bekerja secepat dan seandal mungkin.
- -
title: Dapat Dikustomisasi title: Dapat Dikustomisasi

2
docs/id-ID/advanced-config/README.md
View File

@ -193,7 +193,7 @@ Kamu juga dapat mengatur keluaran yang sama dengan PowerShell dengan membuat seb
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
Ketika menggunakan [aws-vault](https://github.com/99designs/aws-vault), profil dibaca dari variabel environment `AWS_VAULT` dan tanggal kedaluwarsanya dibaca dari variabel environment `AWS_SESSION_EXPIRATION`. Ketika menggunakan [aws-vault](https://github.com/99designs/aws-vault), profil dibaca dari variabel environment `AWS_VAULT` dan tanggal kedaluwarsanya dibaca dari variabel environment `AWS_SESSION_EXPIRATION`.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Opsi ### Opsi
| Variabel | Bawaan | Deskripsi | | Variabel | Bawaan | Deskripsi |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Contoh ### Contoh
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Baterai ## Baterai
Modul `battery` menampilkan seberapa penuh baterai perangkat terisi dan status pengisiannya. Modulnya hanya dapat terlihat ketika baterai perangkat di bawah 10%. Modul `battery` menampilkan seberapa penuh baterai perangkat terisi dan status pengisiannya. Modulnya hanya dapat terlihat ketika baterai perangkat di bawah 10%.
@ -467,11 +478,11 @@ Modul `battery` menampilkan seberapa penuh baterai perangkat terisi dan status p
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| -------------------- | --------------------------------- | --------------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------------- |
| `full_symbol` | `' '` | Simbol dimunculkan ketika baterai penuh. | | `full_symbol` | `'󰁹 '` | Simbol dimunculkan ketika baterai penuh. |
| `charging_symbol` | `' '` | Simbol dimunculkan ketika baterai mengisi. | | `charging_symbol` | `'󰂄 '` | Simbol dimunculkan ketika baterai mengisi. |
| `discharging_symbol` | `' '` | Simbol dimunculkan ketika baterai terpakai. | | `discharging_symbol` | `'󰂃 '` | Simbol dimunculkan ketika baterai terpakai. |
| `unknown_symbol` | `' '` | Simbol dimunculkan ketika keadaan baterai tidak dikenali. | | `unknown_symbol` | `'󰁽 '` | Simbol dimunculkan ketika keadaan baterai tidak dikenali. |
| `empty_symbol` | `' '` | Simbol dimunculkan ketika keadaan baterai kosong. | | `empty_symbol` | `'󰂎 '` | Simbol dimunculkan ketika keadaan baterai kosong. |
| `format` | `'[$symbol$percentage]($style) '` | Format dari modul. | | `format` | `'[$symbol$percentage]($style) '` | Format dari modul. |
| `display` | [link](#battery-display) | Menampilkan ambang dan gaya dari modul. | | `display` | [link](#battery-display) | Menampilkan ambang dan gaya dari modul. |
| `disabled` | `false` | Menonaktifkan modul `baterai`. | | `disabled` | `false` | Menonaktifkan modul `baterai`. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Gaya penataan untuk modul. | | `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `fromat` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format dari modul. | | `fromat` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format dari modul. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variabel ### Variabel
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Gaya penataan untuk modul. | | `style` | `'bold red'` | Gaya penataan untuk modul. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Menyalin nilai dari opsi `style` | | style\* | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `format` | `'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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['go']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `['Godeps']` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `['Godeps']` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `'bold cyan'` | Gaya penataan untuk modul. | | `style` | `'bold cyan'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variabel ### Variabel
| Variabel | Contoh | Deskripsi | | Variabel | Contoh | Deskripsi |
| --------- | --------- | --------------------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Menyalin nilai dari opsi `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Menyalin nilai dari opsi `style` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variabel ### Variabel
| Variabel | Contoh | Deskripsi | | Variabel | Contoh | Deskripsi |
| --------- | ---------- | --------------------------------- | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Menyalin nilai dari opsi `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Menyalin nilai dari opsi `style` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `"bold blue"` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables this module. |
### Variabel
| Variabel | Contoh | Deskripsi |
| --------- | -------- | --------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
### Contoh
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4162,7 +4229,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `deskripsi` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Langkah 2. Setup your shell to use Starship ### Langkah 2. Set up your shell to use Starship
Configure your shell to initialize starship. Select yours from the list below: Configure your shell to initialize starship. Select yours from the list below:

2
docs/it-IT/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Opzioni ### Opzioni
| Variable | Default | Descrizione | | Variable | Default | Descrizione |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blu grassetto'` | The style used in the format. | | `style` | `'blu grassetto'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Lo stile per il modulo. | | `style` | `'bold blue'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Lo stile per il modulo. | | `style` | `'bold red'` | Lo stile per il modulo. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Opzioni ### Opzioni
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['go']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `['Godeps']` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `['Godeps']` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `'bold cyan'` | Lo stile per il modulo. | | `style` | `'bold cyan'` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `"bold blue"` | Lo stile per il modulo. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Esempio | Descrizione |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Esempio
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4162,7 +4229,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `descrizione` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Russo" alt="Russo"
/></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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Fase 2. Imposta la tua shell a utilizzare Starship ### Fase 2. Set up your shell to use Starship
Configura la shell a inizializzare Starship. Seleziona la tua dalla lista qui sotto: Configura la shell a inizializzare Starship. Seleziona la tua dalla lista qui sotto:

2
docs/ja-JP/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
`aws`モジュールは、一時的な資格情報を使用する場合、現在のAWSリージョンとプロファイル、および有効期限タイマーを表示します。 モジュールの出力は、必要に応じて`AWS_REGION`、`AWS_DEFAULT_REGION`と`AWS_PROFILE`の環境変数と、`~/.aws/config`と`~/.aws/credentials`のファイルが使用されます。 `aws`モジュールは、一時的な資格情報を使用する場合、現在のAWSリージョンとプロファイル、および有効期限タイマーを表示します。 モジュールの出力は、必要に応じて`AWS_REGION`、`AWS_DEFAULT_REGION`と`AWS_PROFILE`の環境変数と、`~/.aws/config`と`~/.aws/credentials`のファイルが使用されます。
モジュールは、資格情報が`~/.aws/credentials`にある場合、または`~/.aws/config`に`credential_process`または`sso_start_url`が定義されている場合にのみプロファイルを表示します。 あるいは、環境変数に`AWS_ACCESS_KEY_ID`、`AWS_SECRET_ACCESS_KEY`または`AWS_SESSION_TOKEN`のいずれかが定義されていれば条件を満たします。 もし`force_display`のオプションを`true`に設定した場合、上記の条件による資格情報が検出されない場合でも、利用可能なすべての情報が表示されます。 The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. あるいは、環境変数に`AWS_ACCESS_KEY_ID`、`AWS_SECRET_ACCESS_KEY`または`AWS_SESSION_TOKEN`のいずれかが定義されていれば条件を満たします。 もし`force_display`のオプションを`true`に設定した場合、上記の条件による資格情報が検出されない場合でも、利用可能なすべての情報が表示されます。
[aws-vault](https://github.com/99designs/aws-vault)を使う場合、環境変数`AWS_VAULT`からプロファイルが、環境変数`AWS_SESSION_EXPIRATION`から資格情報の有効期限が読み込まれます。 [aws-vault](https://github.com/99designs/aws-vault)を使う場合、環境変数`AWS_VAULT`からプロファイルが、環境変数`AWS_SESSION_EXPIRATION`から資格情報の有効期限が読み込まれます。
@ -426,12 +427,13 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
### オプション ### オプション
| 変数 | デフォルト | 説明 | | 変数 | デフォルト | 説明 |
| ---------- | ---------------------------------------- | ----------------------- | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | Azure module のフォーマットです。 | | `format` | `'on [$symbol($subscription)]($style) '` | Azure module のフォーマットです。 |
| `symbol` | `'ﴃ '` | フォーマットで使用される記号です。 | | `symbol` | `'󰠅 '` | フォーマットで使用される記号です。 |
| `style` | `'blue bold'` | フォーマットで使用されるスタイルです。 | | `style` | `'blue bold'` | フォーマットで使用されるスタイルです。 |
| `disabled` | `true` | `azure`モジュールを無効にします。 | | `disabled` | `true` | `azure`モジュールを無効にします。 |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### 設定例 ### 設定例
@ -443,7 +445,7 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## バッテリー ## バッテリー
`battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。 モジュールは、デバイスのバッテリー残量が10％未満の場合にのみ表示されます。 `battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。 モジュールは、デバイスのバッテリー残量が10％未満の場合にのみ表示されます。
@ -467,11 +478,11 @@ style = "blue bold"
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| -------------------- | --------------------------------- | ------------------------- | | -------------------- | --------------------------------- | ------------------------- |
| `full_symbol` | `' '` | バッテリーが満タンのときに表示される記号です。 | | `full_symbol` | `'󰁹 '` | バッテリーが満タンのときに表示される記号です。 |
| `charging_symbol` | `' '` | バッテリーの充電中に表示される記号です。 | | `charging_symbol` | `'󰂄 '` | バッテリーの充電中に表示される記号です。 |
| `discharging_symbol` | `' '` | バッテリーが放電しているときに表示される記号です。 | | `discharging_symbol` | `'󰂃 '` | バッテリーが放電しているときに表示される記号です。 |
| `unknown_symbol` | `' '` | バッテリー状態が不明なときに表示される記号です。 | | `unknown_symbol` | `'󰁽 '` | バッテリー状態が不明なときに表示される記号です。 |
| `empty_symbol` | `' '` | バッテリーが空のときに表示される記号です。 | | `empty_symbol` | `'󰂎 '` | バッテリーが空のときに表示される記号です。 |
| `format` | `'[$symbol$percentage]($style) '` | module のフォーマットです。 | | `format` | `'[$symbol$percentage]($style) '` | module のフォーマットです。 |
| `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 | | `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 |
| `disabled` | `false` | `battery`モジュールを無効にします。 | | `disabled` | `false` | `battery`モジュールを無効にします。 |
@ -1517,16 +1528,19 @@ truncation_symbol = ''
`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.
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ----------------- | ---------------------------------------------------------- | ----------------------------- | | ----------------- | ---------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 |
| `symbol` | `'☁️ '` | 現在のGCPプロファイルを表示する前に表示される記号です。 | | `symbol` | `'☁️ '` | 現在のGCPプロファイルを表示する前に表示される記号です。 |
| `region_aliases` | `{}` | GCP名に加えて表示するリージョンのエイリアスです。 | | `region_aliases` | `{}` | GCP名に加えて表示するリージョンのエイリアスです。 |
| `project_aliases` | `{}` | GCP名に加えて表示するプロジェクトのエイリアスです。 | | `project_aliases` | `{}` | GCP名に加えて表示するプロジェクトのエイリアスです。 |
| `style` | `'bold blue'` | モジュールのスタイルです。 | | `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `disabled` | `false` | `gcloud`モジュールを無効にします。 | | `style` | `'bold blue'` | モジュールのスタイルです。 |
| `disabled` | `false` | `gcloud`モジュールを無効にします。 |
### 変数 ### 変数
@ -1724,6 +1738,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | module のフォーマットです。 | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | module のフォーマットです。 |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### 変数 ### 変数
@ -1772,6 +1787,7 @@ WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Status
| `staged` | `'+'` | `staged`のフォーマット | | `staged` | `'+'` | `staged`のフォーマット |
| `renamed` | `'»'` | `renamed`のフォーマット | | `renamed` | `'»'` | `renamed`のフォーマット |
| `deleted` | `'✘'` | `deleted`のフォーマット | | `deleted` | `'✘'` | `deleted`のフォーマット |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | モジュールのスタイルです。 | | `style` | `'bold red'` | モジュールのスタイルです。 |
| `ignore_submodules` | `false` | サブモジュールの変更を無視します。 | | `ignore_submodules` | `false` | サブモジュールの変更を無視します。 |
| `disabled` | `false` | `git_status`モジュールを無効にします。 | | `disabled` | `false` | `git_status`モジュールを無効にします。 |
@ -1792,6 +1808,7 @@ WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Status
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | オプション `style` の値をミラーする | | style\* | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -1864,24 +1881,26 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------ | | ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `['go']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `['Godeps']` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `['Godeps']` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `'bold cyan'` | モジュールのスタイルです。 | | `style` | `'bold cyan'` | モジュールのスタイルです。 |
| `disabled` | `false` | `golang`モジュールを無効にします。 | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | `golang`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | --------- | ----------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | オプション `symbol` の値をミラーする | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | オプション `style` の値をミラーする | | symbol | | オプション `symbol` の値をミラーする |
| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -1894,6 +1913,15 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------- | ----------------------- | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | オプション `symbol` の値をミラーする | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | オプション `style` の値をミラーする | | symbol | | オプション `symbol` の値をミラーする |
| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -3565,7 +3594,7 @@ The `shell` module shows an indicator for currently used shell.
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### オプション
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${major}.${minor}.${patch}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables this module. |
### 変数
| 変数 | 設定例 | 説明 |
| --------- | -------- | ------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| symbol | | オプション `symbol` の値をミラーする |
| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
### 設定例
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4161,8 +4228,8 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [この表の下を参照してください](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `説明` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ curl -sS https://starship.rs/install.sh | sh
</details> </details>
### Step 2. Starshipをシェルにセットアップ ### Step 2. Set up your shell to use Starship
Starshipを初期化するためのシェルの設定。 以下のリストからお使いのシェルを選択してください。 Starshipを初期化するためのシェルの設定。 以下のリストからお使いのシェルを選択してください。

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

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description | | Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. | | `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. | | `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Example
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -169,7 +177,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/)가 설치되어 있고 사용 가능해야 합니다. (ex. [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads))
### 1단계. Starship 설치하기 ### 1단계. Starship 설치하기
@ -202,13 +210,13 @@
<details> <details>
<summary>Linux</summary> <summary>Linux</summary>
Install the latest version for your system: 사용중인 시스템에서 최신버전을 설치해주세요.
```sh ```sh
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
``` ```
Alternatively, install Starship using any of the following package managers: 다음의 패키지 관리자를 사용해서 Starship을 설치할 수도 있습니다.
| Distribution | Repository | Instructions | | Distribution | Repository | Instructions |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
@ -229,13 +237,13 @@ Alternatively, install Starship using any of the following package managers:
<details> <details>
<summary>macOS</summary> <summary>macOS</summary>
Install the latest version for your system: 사용중인 시스템에서 최신버전을 설치해주세요.
```sh ```sh
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
``` ```
Alternatively, install Starship using any of the following package managers: 다음의 패키지 관리자를 사용해서 Starship을 설치할 수도 있습니다.
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
@ -263,7 +271,7 @@ Install the latest version for your system with the MSI-installers from the [rel
</details> </details>
### 2단계. 쉘에 Starship 적용하기 ### 2단계. Set up your shell to use Starship
쉘에 Starship 초기 설정을 합니다. 아래의 리스트 중에 해당하는 것을 고르세요: 쉘에 Starship 초기 설정을 합니다. 아래의 리스트 중에 해당하는 것을 고르세요:

2
docs/nl-NL/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description | | Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. | | `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. | | `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Example
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Installeer Starship met één van de volgende pakketbeheerders:
</details> </details>
### Stap 2. Setup your shell to use Starship ### Stap 2. Set up your shell to use Starship
Configure your shell to initialize starship. Select yours from the list below: Configure your shell to initialize starship. Select yours from the list below:

2
docs/no-NO/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description | | Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. | | `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. | | `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Example
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Russisk" alt="Russisk"
/></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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Installer Starship ved å bruke en av følgende installasjonsprogrammene:
</details> </details>
### Steg 2. Sett opp skallet ditt for å bruke Starship ### Steg 2. Set up your shell to use Starship
Konfigurer skallet ditt til å initialisere starship. Velg din fra listen nedenfor: Konfigurer skallet ditt til å initialisere starship. Velg din fra listen nedenfor:

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

@ -55,7 +55,7 @@ description: Starship to minimalny, szybki i ekstremalnie konfigurowalny wiersz
```sh ```sh
brew install starship brew install starship
``` ```
With [Winget](https://github.com/microsoft/winget-cli): Za pomocą [Winget](https://github.com/microsoft/winget-cli):
```powershell ```powershell
winget install starship winget install starship

2
docs/pl-PL/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| Zmienne | Default | Description | | Zmienne | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description | | Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -824,7 +835,7 @@ format = 'underwent [$duration](bold yellow)'
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
::: tip ::: porada
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
@ -1307,13 +1318,13 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip ::: porada
The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined.
::: :::
::: tip ::: porada
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1709,7 +1723,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
The `git_metrics` module will show the number of added and deleted lines in the current git repository. The `git_metrics` module will show the number of added and deleted lines in the current git repository.
::: tip ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1750,7 +1765,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
The `git_status` module shows symbols representing the state of the repo in your current directory. The `git_status` module shows symbols representing the state of the repo in your current directory.
::: tip ::: porada
The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths.
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. | | `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. | | `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Zmienne | Example | Description | | Zmienne | Example | Description |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2297,7 +2325,7 @@ kotlin_binary = 'kotlinc'
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. 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 ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -2479,7 +2507,7 @@ The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero. By default the swap usage is displayed if the total system swap is non-zero.
::: tip ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Zmienne | Example | Description | | Zmienne | Example | Description |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -2851,7 +2880,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known
::: :::
::: tip ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -3096,7 +3125,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
::: tip ::: porada
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version).
@ -3223,7 +3252,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_folders` | `[]` | Which folders should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module |
| `disabled` | `false` | Disables the `python` module. | | `disabled` | `false` | Disables the `python` module. |
::: tip ::: porada
The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
@ -3525,7 +3554,7 @@ symbol = '🌟 '
The `shell` module shows an indicator for currently used shell. The `shell` module shows an indicator for currently used shell.
::: tip ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Zmienne | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Example
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -3677,7 +3744,7 @@ format = '[$symbol$environment](dimmed blue) '
The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.
::: tip ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -3738,7 +3805,7 @@ disabled = false
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
::: tip ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -3826,7 +3893,7 @@ format = 'via [🏎 $version](red bold)'
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
::: tip ::: porada
By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
@ -3885,7 +3952,7 @@ format = '[🏎💨 $workspace]($style) '
The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: porada
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -3936,7 +4003,7 @@ The `username` module shows active user's username. The module will be shown if
- The user is currently connected as an SSH session - The user is currently connected as an SSH session
- The variable `show_always` is set to true - The variable `show_always` is set to true
::: tip ::: porada
SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
@ -4128,19 +4195,19 @@ These modules will be shown if any of the following conditions are met:
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matches with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: porada
Multiple custom modules can be defined by using a `.`. Multiple custom modules can be defined by using a `.`.
::: :::
::: tip ::: porada
The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined.
::: :::
::: tip ::: porada
[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -169,7 +177,7 @@
### Wymagania wstępne ### Wymagania wstępne
- 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)). - Czcionka [Nerd Font](https://www.nerdfonts.com/) zainstalowana i włączona w Twoim terminalu (na przykład spróbuj [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)).
### Krok 1. Zainstaluj Starship ### Krok 1. Zainstaluj Starship

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

@ -2,64 +2,64 @@
Poniżej zamieszczono zestaw gotowych konfiguracji Starship stworzonych przez społeczność. Jeżeli chcesz zamieścić własną konfigurację, [złóż PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) z modyfikacją tego pliku! 😊 Poniżej zamieszczono zestaw gotowych konfiguracji Starship stworzonych przez społeczność. Jeżeli chcesz zamieścić własną konfigurację, [złóż PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) z modyfikacją tego pliku! 😊
To get details on how to use a preset, simply click on the image. Aby uzyskać szczegółowe informacje na temat użytkowania ustawień, po prostu kliknij na obraz.
## [Symbole Nerd Font](./nerd-font.md) ## [Symbole Nerd Font](./nerd-font.md)
This preset changes the symbols for each module to use Nerd Font symbols. Ten zestaw ustawień zmienia symbole dla każdego modułu tak, by wykorzystywały symbole czcionki Nerd Font.
[![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) [![Zrzut ekranu ustawień symboli czcionki Nerd Font](/presets/img/nerd-font-symbols.png "Kliknij, aby wyświetlić ustawienia symboli Nerd Font")](./nerd-font)
## [No Nerd Fonts](./no-nerd-font.md) ## [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. To ustawienie zmienia symbole dla kilku modułów, tak aby żadne symbole Nerd Font nie były używane w wierszu poleceń.
::: tip ::: porada
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). To ustawienie stanie się domyślnym ustawieniem [w przyszłej wersji starship](https://github.com/starship/starship/pull/3544).
::: :::
[Click to view No Nerd Font preset](./no-nerd-font) [Kliknij, aby wyświetlić ustawienia No Nerd Font](./no-nerd-font)
## [Moduły w nawiasach kwadratowych](./bracketed-segments.md) ## [Moduły w nawiasach kwadratowych](./bracketed-segments.md)
Ta konfiguracja zmienia format wyświetlania wbudowanych modułów - zamiast domyślnych wyrazów ("via", "on", itp.) są wypisywane w nawiasach kwadratowych. Ta konfiguracja zmienia format wyświetlania wbudowanych modułów - zamiast domyślnych wyrazów ("via", "on", itp.) są wypisywane w nawiasach kwadratowych.
[![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) [![Zrzut ekranu ustawień "Moduły w nawiasach kwadratowych"](/presets/img/bracketed-segments.png "Kliknij, aby wyświetlić ustawienia "Moduły w nawiasach kwadratowych"")](./bracketed-segments)
## [Symbole "plain text"](./plain-text.md) ## [Symbole "plain text"](./plain-text.md)
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. Ten zestaw ustawień zmienia symbole w zwykły tekst dla każdego modułu. Świetne, jeśli nie masz dostępu do Unicode.
[![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) [![Zrzut ekranu ustawień Plain Text Symbols](/presets/img/plain-text-symbols.png "Kliknij, aby wyświetlić ustawienia symboli zwykłego tekstu")](./plain-text)
## [No Runtime Versions](./no-runtimes.md) ## [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! Ten zestaw ustawień ukrywa wersję środowiska wykonawczego. Jeśli pracujesz w kontenerach lub wirtualnych środowiskach, to jest to dla Ciebie!
[![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) [![Zrzut ekranu No Runtime Versions](/presets/img/no-runtime-versions.png "Kliknij, aby wyświetlić ustawienia No Runtime Versions")](./no-runtimes)
## [No Empty Icons](./no-empty-icons.md) ## [No Empty Icons](./no-empty-icons.md)
This preset does not show icons if the toolset is not found. Ten zestaw ustawień nie wyświetla ikon, jeśli zestaw narzędzi nie został znaleziony.
[![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png "Click to view No Runtime Versions preset")](./no-empty-icons.md) [![Zrzut ekranu ustawień No Empty Icons](/presets/img/no-empty-icons.png "Kliknij, aby wyświetlić ustawienia No Runtime Versions")](./no-empty-icons.md)
## [Pure Prompt](./pure-preset.md) ## [Wiersz poleceń "Pure"](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). Ten zestaw ustawień naśladuje wygląd i zachowanie [Pure](https://github.com/sindresorhus/pure).
[![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset) [![Zrzut ekranu ustawień Pure](/presets/img/pure-preset.png "Kliknij, aby wyświetlić ustawienia wiersza Pure")](./pure-preset)
## [Pastel Powerline](./pastel-powerline.md) ## [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. Ten zestaw ustawień jest inspirowany [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Pokazuje ono również, jak działa zastępowanie ścieżek w starship.
[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) [![Zrzut ekranu ustawień Pastel Powerline](/presets/img/pastel-powerline.png "Kliknij, aby wyświetlić ustawienia wiersza Pure")](./pastel-powerline)
## [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). Ten zestaw ustawień jest inspirowany [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) [![Zrzut ekranu ustawień Tokio Night](/presets/img/tokyo-night.png "Kliknij, aby wyświetlić ustawienia Tokio Night")](./tokyo-night)

8
docs/pl-PL/presets/bracketed-segments.md
View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#bracketed-segments) [Powrót do ustawień predefiniowanych](./README.md#bracketed-segments)
# Bracketed Segments Preset # Ustawienia modułów w nawiasach kwadratowych
Ta konfiguracja zmienia format wyświetlania wbudowanych modułów - zamiast domyślnych wyrazów ("via", "on", itp.) są wypisywane w nawiasach kwadratowych. Ta konfiguracja zmienia format wyświetlania wbudowanych modułów - zamiast domyślnych wyrazów ("via", "on", itp.) są wypisywane w nawiasach kwadratowych.
![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png) ![Zrzut ekranu ustawień "Moduły w nawiasach kwadratowych"](/presets/img/bracketed-segments.png)
### Konfiguracja ### Konfiguracja
@ -12,6 +12,6 @@ Ta konfiguracja zmienia format wyświetlania wbudowanych modułów - zamiast dom
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) [Kliknij, aby pobrać TOML](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/.vuepress/public/presets/toml/bracketed-segments.toml

10
docs/pl-PL/presets/nerd-font.md
View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#nerd-font-symbols) [Powrót do ustawień predefiniowanych](./README.md#nerd-font-symbols)
# Nerd Font Symbols Preset # Ustawienia symboli Nerd Font
This preset changes the symbols for each module to use Nerd Font symbols. Ten zestaw ustawień zmienia symbole dla każdego modułu tak, by wykorzystywały symbole czcionki Nerd Font.
![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png) ![Zrzut ekranu ustawień symboli czcionki Nerd Font](/presets/img/nerd-font-symbols.png)
### Wymagania wstępne ### Wymagania wstępne
@ -16,6 +16,6 @@ This preset changes the symbols for each module to use Nerd Font symbols.
starship preset nerd-font-symbols -o ~/.config/starship.toml starship preset nerd-font-symbols -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/nerd-font-symbols.toml) [Kliknij, aby pobrać TOML](/presets/toml/nerd-font-symbols.toml)
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml <<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml

10
docs/pl-PL/presets/no-empty-icons.md
View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#no-empty-icons) [Powrót do ustawień predefiniowanych](./README.md#no-empty-icons)
# No Empty Icons Preset # Ustawienia No Empty Icons
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. Ikony zestawów narzędzi będą wyświetlane dla zidentyfikowanych plików zestawów narzędzi. Jeżeli zestaw narzedzi nie dysponuje numerem wersji, to nie jest on wyświetlany. Ustawienia te sprawiają, że ikona zostanie wyświetlona tylko wtedy, gdy można określić informacje o zestawie narzędzi.
![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png) ![Zrzut ekranu ustawień No Empty Icons](/presets/img/no-empty-icons.png)
### Konfiguracja ### Konfiguracja
@ -12,6 +12,6 @@ If toolset files are identified the toolset icon is displayed. If the toolset is
starship preset no-empty-icons -o ~/.config/starship.toml starship preset no-empty-icons -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/no-empty-icons.toml) [Kliknij, aby pobrać TOML](/presets/toml/no-empty-icons.toml)
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml <<< @/.vuepress/public/presets/toml/no-empty-icons.toml

12
docs/pl-PL/presets/no-nerd-font.md
View File

@ -1,12 +1,12 @@
[Return to Presets](./README.md#no-nerd-fonts) [Powrót do ustawień predefiniowanych](./README.md#no-nerd-fonts)
# No Nerd Fonts Preset # Ustawienia No Nerd Fonts
This preset restricts the use of symbols to those from emoji and powerline sets. Ustawiania te ograniczają użycie symboli do tych z zestawów emoji oraz powerline.
This means that even without a Nerd Font installed, you should be able to view all module symbols. Oznacza to, że nawet bez zainstalowanej czcionki Nerd Font powinno być możliwe wyświetlenie wszystkich symboli modułu.
This preset will become the default preset in a future release of starship. Ten zestaw ustawień stanie się domyślny w przyszłych wersjach starship.
### Konfiguracja ### Konfiguracja
@ -14,6 +14,6 @@ This preset will become the default preset in a future release of starship.
starship preset no-nerd-font -o ~/.config/starship.toml starship preset no-nerd-font -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/no-nerd-font.toml) [Kliknij, aby pobrać TOML](/presets/toml/no-nerd-font.toml)
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml <<< @/.vuepress/public/presets/toml/no-nerd-font.toml

10
docs/pl-PL/presets/no-runtimes.md
View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#no-runtime-versions) [Powrót do ustawień predefiniowanych](./README.md#no-runtime-versions)
# No Runtime Versions Preset # Ustawienia No Runtime Versions
This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! Ten zestaw ustawień ukrywa wersję środowiska wykonawczego. Jeśli pracujesz w kontenerach lub wirtualnych środowiskach, to jest to dla Ciebie!
![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png) ![Zrzut ekranu No Runtime Versions](/presets/img/no-runtime-versions.png)
### Konfiguracja ### Konfiguracja
@ -12,6 +12,6 @@ This preset hides the version of language runtimes. If you work in containers or
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) [Kliknij, aby pobrać TOML](/presets/toml/no-runtime-versions.toml)
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml <<< @/.vuepress/public/presets/toml/no-runtime-versions.toml

12
docs/pl-PL/presets/pastel-powerline.md
View File

@ -1,14 +1,14 @@
[Return to Presets](./README.md#pastel-powerline) [Powrót do ustawień predefiniowanych](./README.md#pastel-powerline)
# Pastel Powerline Preset # Ustawienia Pastel Powerline
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. Ten zestaw ustawień jest inspirowany [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Pokazuje ono również, jak działa zastępowanie ścieżek w starship.
![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) ![Zrzut ekranu ustawień Pastel Powerline](/presets/img/pastel-powerline.png)
### Wymagania wstępne ### Wymagania wstępne
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) - Czcionka [Nerd Font](https://www.nerdfonts.com/) zainstalowana i ustawiona w twoim terminalu (w przykładzie użyto czcionki Caskaydia Cove Nerd Font)
### Konfiguracja ### Konfiguracja
@ -16,6 +16,6 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
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) [Kliknij, aby pobrać TOML](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml <<< @/.vuepress/public/presets/toml/pastel-powerline.toml

10
docs/pl-PL/presets/plain-text.md
View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#plain-text-symbols) [Powrót do ustawień predefiniowanych](./README.md#plain-text-symbols)
## Plain Text Symbols Preset ## Ustawienia Plain Text Symbols
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. Ten zestaw ustawień zmienia symbole w zwykły tekst dla każdego modułu. Świetne, jeśli nie masz dostępu do Unicode.
![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png) ![Zrzut ekranu ustawień Plain Text Symbols](/presets/img/plain-text-symbols.png)
### Konfiguracja ### Konfiguracja
@ -12,6 +12,6 @@ This preset changes the symbols for each module into plain text. Great if you do
starship preset plain-text-symbols -o ~/.config/starship.toml starship preset plain-text-symbols -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/plain-text-symbols.toml) [Kliknij, aby pobrać TOML](/presets/toml/plain-text-symbols.toml)
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml <<< @/.vuepress/public/presets/toml/plain-text-symbols.toml

10
docs/pl-PL/presets/pure-preset.md
View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#pure) [Powrót do ustawień predefiniowanych](./README.md#pure)
# Pure Preset # Ustawienia Pure
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). Ten zestaw ustawień naśladuje wygląd i zachowanie [Pure](https://github.com/sindresorhus/pure).
![Screenshot of Pure preset](/presets/img/pure-preset.png) ![Zrzut ekranu ustawień Pure](/presets/img/pure-preset.png)
### Konfiguracja ### Konfiguracja
@ -12,6 +12,6 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
starship preset pure-preset -o ~/.config/starship.toml starship preset pure-preset -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/pure-preset.toml) [Kliknij, aby pobrać TOML](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml <<< @/.vuepress/public/presets/toml/pure-preset.toml

10
docs/pl-PL/presets/tokyo-night.md
View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#pastel-powerline) [Powrót do ustawień predefiniowanych](./README.md#pastel-powerline)
# Tokyo Night Preset # Ustawienia Tokyo Night
This preset is inspired by [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).
![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png) ![Zrzut ekranu ustawień Tokio Night](/presets/img/tokyo-night.png)
### Wymagania wstępne ### Wymagania wstępne
@ -16,6 +16,6 @@ This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/t
starship preset tokyo-night -o ~/.config/starship.toml starship preset tokyo-night -o ~/.config/starship.toml
``` ```
[Click to download TOML](/presets/toml/tokyo-night.toml) [Kliknij, aby pobrać TOML](/presets/toml/tokyo-night.toml)
<<< @/.vuepress/public/presets/toml/tokyo-night.toml <<< @/.vuepress/public/presets/toml/tokyo-night.toml

2
docs/pt-BR/README.md
View File

@ -153,7 +153,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
::: :::
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): Adicione o seguinte ao final do seu arquivo env do Nushell (enconte-o rodando `$nu.env-path` no Nushell):
```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

50
docs/pt-BR/advanced-config/README.md
View File

@ -10,9 +10,9 @@ As configurações nesta seção estão sujeitas a alterações em futuras vers
## TransientPrompt no PowerShell ## TransientPrompt no 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`. É possível substituir o prompt anteriormente impresso por uma string personalisada. Isto é útil quando todas as informações do prompt não são nescessárias sempre. Para habilitar isto, execute `Enable-TransientPrompt` na sessão do shell. Para ser permanente, adicione esta declaração no seu `$PROFILE`. A transição pode ser desativada com `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 Por padrão, o lado esquerdo da entrada é substituida por `>`. Para personalizar isso defina uma nova função chamada `Invoke-Starship-TransientFunction`. Por exemplo, para mostrar o módulo de caractere do ` Starship's`aqui, você faria
```powershell ```powershell
function Invoke-Starship-TransientFunction { function Invoke-Starship-TransientFunction {
@ -24,17 +24,17 @@ Invoke-Expression (&starship init powershell)
Enable-TransientPrompt Enable-TransientPrompt
``` ```
## TransientPrompt and TransientRightPrompt in Cmd ## TransientPrompt e TransientRightPrompt em 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: Clink permite você substituir o prompt anteriormente impresso com strings personalizadas. Isto é útil quando todas as informações do prompt não são nescessárias sempre. Para habilitar isso, execute `clink set prompt.transient <value>` onde \<value\> pode ser um dos:
- `always`: always replace the previous prompt - `always`: sempre substitui o prompt anterior
- `same_dir`: replace the previous prompt only if the working directory is same - `same_dir`: substitui o prompt anterior apenas se o diretório de trabalho for o mesmo
- `off`: do not replace the prompt (i.e. turn off transience) - `off`: não substitui o prompt (ou seja, desliga a transição)
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: Você precisa fazer isso apenas uma vez. Faça as seguintes alterações ao seu `starship.lua` para personalizar o que é exibido à esquerda e à direita:
- 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 - Por padrão, o lado esquerdo da entrada é substituida por `>`. Para personalizar isso, defina uma nova função chamada `starship_transient_prompt_func`. Esta função recebe o prompt atual como uma string que você pode utilizar. Por exemplo, para mostrar o módulo de caractere do ` Starship's`aqui, você faria
```lua ```lua
function starship_transient_prompt_func(prompt) function starship_transient_prompt_func(prompt)
@ -45,7 +45,7 @@ end
load(io.popen('starship init cmd'):read("*a"))() 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 - Por padrão, o lado direito da entrada é vazio. Para personalizar isso, defina uma nova função chamada `starship_transient_rprompt_func`. Esta função recebe a prompt atual de como uma string que você pode utilizar. Por exemplo, para exibir o momento em que o último comando foi iniciado, você faria
```lua ```lua
function starship_transient_rprompt_func(prompt) function starship_transient_rprompt_func(prompt)
@ -54,23 +54,23 @@ end
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
``` ```
## TransientPrompt and TransientRightPrompt in Fish ## TransientPrompt e TransientRightPrompt no 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`. É possível substituir o prompt anteriormente impresso por uma string personalisada. Isto é útil quando todas as informações do prompt não são nescessárias sempre. Para habilitar isso, execute `enable_transience` na sessão do shell. Para torná-lo permanente, coloque esta declaração no seu `~/.config/fish/config.fish`. Transição pode ser desativada com `disable_transience`.
Note that in case of Fish, the transient prompt is only printed if the commandline is non-empty, and syntactically correct. Observe que, no caso do Fish, o prompt transitório só será impresso se a linha de comando não estiver vazia, e sintaticamente correta.
- 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 - Por padrão, o lado esquerdo da entrada é substituído por um símbolo `❯` verde. Para personalizar isso, defina uma nova função chamada `starship_transient_prompt_func`. Por exemplo, para mostrar o módulo de caractere do ` Starship's`aqui, você faria
```fish ```fish
function starship_transient_prompt_func function starship_transient_rprompt_func
starship module character starship module time
end end
starship init fish | source starship init fish | source
enable_transience 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 - Por padrão, o lado direito da entrada é vazio. Para personalizar isso, defina uma nova função chamada `starship_transient_rprompt_func`. Por exemplo, para exibir o momento em que o último comando foi iniciado, você faria
```fish ```fish
function starship_transient_rprompt_func function starship_transient_rprompt_func
@ -193,10 +193,10 @@ Você também pode definir uma saída semelhante com o PowerShell criando uma fu
```powershell ```powershell
# editar $PROFILE # editar $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (& starship init powershell) Invoke-Expression (&starship init powershell)
``` ```
## Ativando o Prompt Direito ## Ativando o Prompt Direito
@ -205,7 +205,7 @@ Alguns shells suportam um prompt direito que é renderizado na mesma linha que a
Nota: O prompt direito é uma única linha após o local de entrada. Para alinhar módulos à direita acima da linha de entrada em um prompt de várias linhas, consulte o [módulo `fill`](/config/#fill). Nota: O prompt direito é uma única linha após o local de entrada. Para alinhar módulos à direita acima da linha de entrada em um prompt de várias linhas, consulte o [módulo `fill`](/config/#fill).
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. `right_format` é atualmente suportado pelos seguintes shells: elvish, fish, zsh, xonsh, cmd, nushell.
### Exemplo ### Exemplo
@ -229,7 +229,7 @@ Produz um prompt como o seguinte:
Alguns shells suportam um prompt de continuação junto com o prompt normal. Esse prompt é renderizado em vez do prompt normal quando o usuário insere uma instrução incompleta (como um único parêntese esquerdo ou aspas). Alguns shells suportam um prompt de continuação junto com o prompt normal. Esse prompt é renderizado em vez do prompt normal quando o usuário insere uma instrução incompleta (como um único parêntese esquerdo ou aspas).
Starship pode definir o prompt de continuação usando a opção `continuation_prompt`. The default prompt is `'[∙](bright-black) '`. Starship pode definir o prompt de continuação usando a opção `continuation_prompt`. O prompt padrão é `'[∙](bright-black) '`.
Nota: `continuation_prompt` deve ser definido como uma string literal sem nenhuma variável. Nota: `continuation_prompt` deve ser definido como uma string literal sem nenhuma variável.
@ -277,8 +277,8 @@ Um especificador de cor pode ser um dos seguintes:
Se várias cores forem especificadas para primeiro plano/plano de fundo, a última na string terá prioridade. Se várias cores forem especificadas para primeiro plano/plano de fundo, a última na string terá prioridade.
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist: Nem todas os estilos de string serão exibidos corretamente em todos terminais. Em particular, existem os seguintes erros conhecidos:
- Many terminals disable support for `blink` by default - Muitos terminais desabilitam por padrão o suporte ao `blink`
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564). - `hidden` não é [ suportado no iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app - `strikethrough` não é suportado por padrão no aplicativo de terminal do macOS

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

@ -9,22 +9,22 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml): Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml):
```toml ```toml
# Get editor completions based on the config schema # Obtém o preenchimento do editor baseado no esquema de configuração
"$schema" = 'https://starship.rs/config-schema.json' "$schema" = 'https://starship.rs/config-schema.json'
# Inserts a blank line between shell prompts # Insere uma linha branca entre os prompts do shell
add_newline = true add_newline = true
# Replace the '❯' symbol in the prompt with '➜' # Substitui o símbolo '❯' no prompt por '➜'
[character] # The name of the module we are configuring is 'character' [character] # O nome do módulo que estamos configurando é 'character'
success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green' success_symbol = '[➜](bold green)' # O 'success_symbol' é definido para '➜' com a cor 'bold green'
# Disable the package module, hiding it from the prompt completely # Desabilita o módulo package, escondendo completamente ele do prompt
[package] [package]
disabled = true disabled = true
``` ```
### Config File Location ### Configuração do Local do Arquivo
Você pode alterar o caminho padrão do arquivo de configuração com a variável de ambiente `STARSHIP_CONFIG`: Você pode alterar o caminho padrão do arquivo de configuração com a variável de ambiente `STARSHIP_CONFIG`:
@ -46,7 +46,7 @@ os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\star
### Logging ### Logging
By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal. Isto, no entanto pode ser alterado usando a variável de ambiente `STARSHIP_CACHE`: Por padrão os logs de avisos e erros do starship estão em um arquivo chamado `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, onde a session key é correspondente a uma instancia do terminal. Isto, no entanto pode ser alterado usando a variável de ambiente `STARSHIP_CACHE`:
```sh ```sh
export STARSHIP_CACHE=~/.starship/cache export STARSHIP_CACHE=~/.starship/cache
@ -74,16 +74,16 @@ Por convenção, a maioria dos módulos tem um prefixo de cor (e.x. `via` no "no
### Strings ### Strings
In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`. Na sintaxe TOML, [valores de texto](https://toml.io/en/v1.0.0#string) são declarados com `'`, `"`, `'''`, ou `"""`.
The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. Os seguintes símbolos de sintaxe do Starship têm uso especial em uma string de formatação e devem ser escapados para exibir como este caractere: `$ [ ] ( )`.
| Symbol | Type | Notes | | Símbolo | Tipo | Notas |
| ------ | ------------------------- | ------------------------------------------------------ | | ------- | -------------------------- | ---------------------------------------------------------------- |
| `'` | literal string | less escaping | | `'` | string literal | menos escapando |
| `"` | string | more escaping | | `"` | string | mais escapando |
| `'''` | multi-line literal string | less escaping | | `'''` | string literal multi-linha | menos escapando |
| `"""` | multi-line string | more escaping, newlines in declarations can be ignored | | `"""` | string multi-linha | mais escapantes, novas linhas em declarações podem ser ignoradas |
Por exemplo: Por exemplo:
@ -98,24 +98,24 @@ format = "☺\\☻ "
format = '\[\$\] ' format = '\[\$\] '
``` ```
When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent: Ao usar quebras de linha, declarações de várias linhas podem ser usadas. Por exemplo, se você quiser imprimir um símbolo `$` em uma nova linha, os seguintes valores para o `format` são equivalentes:
```toml ```toml
# with literal string # com string literal
format = ''' format = '''
\$''' \$'''
# with multiline basic string # com string básica multilinha
format = """ format = """
\\$""" \\$"""
# with basic string # com string básica
format = "\n\\$" format = "\n\\$"
``` ```
In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them. Em strings básicas de várias linhas, newlines podem ser usadas para formatação sem estarem presentes no valor escapado delas.
```toml ```toml
format = """ format = """
@ -138,9 +138,9 @@ Uma variável contém um símbolo `$` seguido pelo nome da variável. O nome de
Por exemplo: Por exemplo:
- `'$version'` is a format string with a variable named `version`. - `'$version'` é uma string de formato com uma variável chamada `version`.
- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`. - `'$git_branch$git_commit'` é uma string de formato com duas variáveis chamadas `git_branch` e `git_commit`.
- `'$git_branch $git_commit'` has the two variables separated with a space. - `'$git_branch $git_commit'` tem as duas variáveis separadas por um espaço.
#### Grupo de Texto #### Grupo de Texto
@ -152,20 +152,20 @@ Na segunda parte, que está dentro de um `()`, está uma [string de estilo](#sty
Por exemplo: Por exemplo:
- `'[on](red bold)'` will print a string `on` with bold text colored red. - `'[on](red bold)'` irá imprimir uma string `em` com texto em negrito vermelho.
- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `'[⌘ $version](bold green)'` imprimirá um símbolo `⌘` seguido pelo conteúdo da `version`, com texto negrito verde.
- `'[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` com `b` vermelhor, `a` e `c` verdes.
#### Estilo dos textos #### Estilo dos textos
A maioria dos módulos no starship permite que você configure seus estilos de exibição. Isso é feito com uma entrada (normalmente chamada de `estilo`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo junto com o que elas fazem. Para obter detalhes sobre a sintaxe completa, consulte o [guia de configuração avançada](/advanced-config/). A maioria dos módulos no starship permite que você configure seus estilos de exibição. Isso é feito com uma entrada (normalmente chamada de `estilo`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo junto com o que elas fazem. Para obter detalhes sobre a sintaxe completa, consulte o [guia de configuração avançada](/advanced-config/).
- `'fg:green bg:blue'` sets green text on a blue background - `"fg:green bg:blue"` define o texto para verde e o fundo azul
- `'bg:blue fg:bright-green'` sets bright green text on a blue background - `"bg:blue fg:bright-green"` define o texto para verde brilhante e o fundo azul
- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27 - `"bold fg:27"` define o texto para negrito com a cor 27 [da tabela ANSI](https://i.stack.imgur.com/KTSQa.png)
- `'underline bg:#bf5700'` sets underlined text on a burnt orange background - `"underline bg:#bf5700"` define o texto para sublinhado com o fundo laranja escuro
- `'bold italic fg:purple'` sets bold italic purple text - `"bold italic fg:purple"` define o texto para negrito e itálico com a cor roxa
- `''` explicitly disables all styling - `"` explicitamente desabilita todos os estilos
Observe que a aparência do estilo será controlada pelo emulador de terminal. Por exemplo, alguns emuladores de terminal irão clarear as cores em vez de colocar o texto em negrito, e alguns temas de cores usam os mesmos valores para as cores normais e brilhantes. Além disso, para obter texto em itálico, seu terminal deve suportar itálico. Observe que a aparência do estilo será controlada pelo emulador de terminal. Por exemplo, alguns emuladores de terminal irão clarear as cores em vez de colocar o texto em negrito, e alguns temas de cores usam os mesmos valores para as cores normais e brilhantes. Além disso, para obter texto em itálico, seu terminal deve suportar itálico.
@ -179,9 +179,9 @@ Por exemplo:
- `'(some text)'` will always show nothing since there are no variables wrapped in the braces. - `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`. - When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching ### Correspondência negativa
Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched. Muitos módulos têm variáveis `detect_extensions`, `detect_files`, e `detect_folders`. Estas receberão listas de strings para coresponder ou não. Opções "negativas", aquelas que não tem correspondencia, são indicadas com um caractere '!'. A presença de _varios_ indicadores negativos no diretório resultara que o módulo não sera correspondido.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all. Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
@ -204,7 +204,7 @@ Esta é a lista de opções de configuração em todo o prompt.
| `scan_timeout` | `30` | Tempo limite para escanear arquivos (em milissegundos). | | `scan_timeout` | `30` | Tempo limite para escanear arquivos (em milissegundos). |
| `command_timeout` | `500` | Tempo limite de execução de comandos pelo starship (em milissegundos). | | `command_timeout` | `500` | Tempo limite de execução de comandos pelo starship (em milissegundos). |
| `add_newline` | `true` | Insere linha vazia entre os prompts do shell. | | `add_newline` | `true` | Insere linha vazia entre os prompts do shell. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `palette` | `''` | Define qual a paleta de cores de `palettes` será usada. |
| `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. |
### Exemplo ### Exemplo
@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -332,7 +333,7 @@ $character"""
Se você quiser apenas estender o formato padrão, você pode usar `$all`; os módulos que você adicionar explicitamente ao formato não serão duplicados. Ex. Se você quiser apenas estender o formato padrão, você pode usar `$all`; os módulos que você adicionar explicitamente ao formato não serão duplicados. Ex.
```toml ```toml
# Move the directory to the second line # Mova o diretório para a segunda linha
format = '$all$directory$character' format = '$all$directory$character'
``` ```
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
Quando usar [aws-vault](https://github.com/99designs/aws-vault), o perfil é lido da variável de ambiente `AWS_VAULT` e o tempo de expiração de credenciais é lido da variável de ambiente `AWS_SESSION_EXPIRATION`. Quando usar [aws-vault](https://github.com/99designs/aws-vault), o perfil é lido da variável de ambiente `AWS_VAULT` e o tempo de expiração de credenciais é lido da variável de ambiente `AWS_SESSION_EXPIRATION`.
@ -426,16 +427,17 @@ O módulo `azure` exibe a assinatura Azure atual. This is based on showing the n
### Opções ### Opções
| Variável | Padrão | Descrição | | Variável | Padrão | Descrição |
| ---------- | ---------------------------------------- | ---------------------------------------------- | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | O formato que o módulo Azure será renderizado. | | `format` | `'on [$symbol($subscription)]($style) '` | O formato que o módulo Azure será renderizado. |
| `symbol` | `'ﴃ '` | O símbolo usado no formato. | | `symbol` | `'󰠅 '` | O símbolo usado no formato. |
| `style` | `'blue bold'` | O estilo usado no formato. | | `style` | `'blue bold'` | O estilo usado no formato. |
| `disabled` | `true` | Desabilita o módulo `azure`. | | `disabled` | `true` | Desabilita o módulo `azure`. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Exemplos ### Exemplos
#### Display Subscription Name #### Exibir Nome da Assinatura
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -443,22 +445,31 @@ O módulo `azure` exibe a assinatura Azure atual. This is based on showing the n
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
#### Display Username #### Exibir Usuário
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
[azure] [azure]
disabled = false disabled = false
format = "em [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Exibir Alias do Nome da Assinatura
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Bateria ## Bateria
O módulo `battery` exibe o quanto a bateria do dispositivo está carregada e o estado atual de carregamento. O módulo é visível somente quando a bateria está abaixo de 10%. O módulo `battery` exibe o quanto a bateria do dispositivo está carregada e o estado atual de carregamento. O módulo é visível somente quando a bateria está abaixo de 10%.
@ -467,11 +478,11 @@ O módulo `battery` exibe o quanto a bateria do dispositivo está carregada e o
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| -------------------- | --------------------------------- | ------------------------------------------------------------ | | -------------------- | --------------------------------- | ------------------------------------------------------------ |
| `full_symbol` | `' '` | O simbolo exibido quando a bateria estiver cheia. | | `full_symbol` | `'󰁹 '` | O simbolo exibido quando a bateria estiver cheia. |
| `charging_symbol` | `' '` | O simbolo exibido quando a bateria está carregando. | | `charging_symbol` | `'󰂄 '` | O simbolo exibido quando a bateria está carregando. |
| `discharging_symbol` | `' '` | O simbolo exibido quando a bateria está descarregando. | | `discharging_symbol` | `'󰂃 '` | O simbolo exibido quando a bateria está descarregando. |
| `unknown_symbol` | `' '` | O simbolo exibido quando o estado da bateria é desconhecido. | | `unknown_symbol` | `'󰁽 '` | O simbolo exibido quando o estado da bateria é desconhecido. |
| `empty_symbol` | `' '` | O simbolo exibido quando o estado da bateria é vazio. | | `empty_symbol` | `'󰂎 '` | O simbolo exibido quando o estado da bateria é vazio. |
| `format` | `'[$symbol$percentage]($style) '` | O formato do módulo. | | `format` | `'[$symbol$percentage]($style) '` | O formato do módulo. |
| `display` | [link](#battery-display) | Limite de exibição e estilo para o módulo. | | `display` | [link](#battery-display) | Limite de exibição e estilo para o módulo. |
| `disabled` | `false` | Desabilita o módulo `battery`. | | `disabled` | `false` | Desabilita o módulo `battery`. |
@ -513,16 +524,16 @@ A opção `display` é um array da seguinte tabela.
#### Exemplo #### Exemplo
```toml ```toml
[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10% [[battery.display]] # ''bold red' e discharging_symbol é exibido quando a capacidade está entre 0% e 10%
threshold = 10 threshold = 10
style = 'bold red' style = 'bold red'
[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30% [[battery.display]] # 'yellow' style e o símbolo 💦 é exibido quando a capacidade está entre 10% e 30%
threshold = 30 threshold = 30
style = 'bold yellow' style = 'bold yellow'
discharging_symbol = '💦' discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed # quando a capacidade estiver acima de 30%, o indicador de bateria não será exibido
``` ```
## Buf ## Buf
@ -534,16 +545,16 @@ O módulo `buf` mostra a versão instalada do [Buf](https://buf.build). Por padr
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ----------------------------------------------- | ------------------------------------------------- | | ------------------- | ------------------------------------- | ------------------------------------------------- |
| `format` | `'with [$symbol($version )]($style)'` | O formato do módulo `buf`. | | `format` | `'with [$symbol($version )]($style)'` | O formato do módulo `buf`. |
| `version_format` | `'v${raw}'` | A versão formatada. | | `version_format` | `'v${raw}'` | A versão formatada. |
| `symbol` | `'🐃 '` | O símbolo usado antes de exibir a versão do Buf. | | `symbol` | `'🐃 '` | O símbolo usado antes de exibir a versão do Buf. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | 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` | Desabilita o módulo `elixir`. | | `disabled` | `false` | Desabilita o módulo `elixir`. |
### Variáveis ### Variáveis
@ -566,7 +577,7 @@ symbol = '🦬 '
## Bun ## Bun
The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: O módulo `bun` mostra a versão atualmente instalada do [bun](https://bun.sh) runtime do JavaScript. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual conter um arquivo `bun.lockb` - O diretório atual conter um arquivo `bun.lockb`
- O diretório atual conter um arquivo `bunfig.toml` - O diretório atual conter um arquivo `bunfig.toml`
@ -577,18 +588,18 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `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 Bun. | | `symbol` | `'🍞 '` | Uma string de formato que representa o símbolo do Bun. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `['bun.lockb', 'bunfig.toml']` | 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 red'` | O estilo do módulo. | | `style` | `'bold red'` | O estilo do módulo. |
| `disabled` | `false` | Disables the `bun` module. | | `disabled` | `false` | Desativa o módulo `bun`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- | | --------- | -------- | --------------------------------- |
| version | `v0.1.4` | The version of `bun` | | version | `v0.1.4` | A versão do `bun` |
| 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` |
@ -681,9 +692,9 @@ Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olh
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| -------- | ------- | -------------------------------------------------------------------------------------------------------- | | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| symbol | | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. | | symbol | | Um espelho de `success_symbol`, `error_symbol`, `vimcmd_symbol` ou `vimcmd_replace_one_symbol` etc. |
### Exemplos ### Exemplos
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
@ -1525,6 +1538,7 @@ O módulo `gcloud` exibe a configuração atual para a CLI do [`gcloud`](https:/
| `symbol` | `'☁️ '` | O simbolo usado antes de exibir o perfil atual do GCP. | | `symbol` | `'☁️ '` | O simbolo usado antes de exibir o perfil atual do GCP. |
| `region_aliases` | `{}` | Tabela de aliases de região para exibir além do nome do GCP. | | `region_aliases` | `{}` | Tabela de aliases de região para exibir além do nome do GCP. |
| `project_aliases` | `{}` | Tabela de apelidos do projeto a serem exibidos além do nome do GCP. | | `project_aliases` | `{}` | Tabela de apelidos do projeto a serem exibidos além do nome do GCP. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | O estilo do módulo. | | `style` | `'bold blue'` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `gcloud`. | | `disabled` | `false` | Desabilita o módulo `gcloud`. |
@ -1724,6 +1738,7 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
| `only_nonzero_diffs` | `true` | Exibe apenas o status para itens alterados. | | `only_nonzero_diffs` | `true` | Exibe apenas o status para itens alterados. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | O formato do módulo. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | O formato do módulo. |
| `disabled` | `true` | Desabilita o módulo `git_metrics`. | | `disabled` | `true` | Desabilita o módulo `git_metrics`. |
| `ignore_submodules` | `false` | Ignora as alterações de submódulos |
### Variáveis ### Variáveis
@ -1772,6 +1787,7 @@ O módulo Git Status é muito lento nos diretórios do Windows (por exemplo, em
| `staged` | `'+'` | O formato do `staged` | | `staged` | `'+'` | O formato do `staged` |
| `renamed` | `'»'` | O formato do `renamed` | | `renamed` | `'»'` | O formato do `renamed` |
| `deleted` | `'✘'` | O formato do `deleted` | | `deleted` | `'✘'` | O formato do `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | O estilo do módulo. | | `style` | `'bold red'` | O estilo do módulo. |
| `ignore_submodules` | `false` | Ignora as alterações de submódulos. | | `ignore_submodules` | `false` | Ignora as alterações de submódulos. |
| `disabled` | `false` | Desabilita o módulo `git_status`. | | `disabled` | `false` | Desabilita o módulo `git_status`. |
@ -1792,6 +1808,7 @@ As variáveis a seguir podem ser usadas no `format`:
| `staged` | Exibe `staged` quando um arquivo novo for adicionado na área de staging. | | `staged` | Exibe `staged` quando um arquivo novo for adicionado na área de staging. |
| `renamed` | Exibe `renamed` quando um arquivo renomeado for adicionado na área de staging. | | `renamed` | Exibe `renamed` quando um arquivo renomeado for adicionado na área de staging. |
| `deleted` | Exibe `deleted` quando um arquivo deletado for adicionado na área de staging. | | `deleted` | Exibe `deleted` quando um arquivo deletado for adicionado na área de staging. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Espelha o valor da opção `style` | | style\* | Espelha o valor da opção `style` |
*: 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
@ -1864,24 +1881,26 @@ O módulo `golang` exibe a versão instalada atual do [Go](https://golang.org/).
### Opções ### Opções
| 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` | `'🐹 '` | O formato da string que representa o simbolo do Go. | | `symbol` | `'🐹 '` | O formato da string que representa o simbolo do Go. |
| `detect_extensions` | `['go']` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `['go']` | Quais extensões devem ativar este módulo. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `['Godeps']` | Quais pastas devem ativar este módulo. | | `detect_folders` | `['Godeps']` | Quais pastas devem ativar este módulo. |
| `style` | `'bold cyan'` | O estilo do módulo. | | `style` | `'bold cyan'` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `golang`. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Desabilita o módulo `golang`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | --------- | --------------------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | A versão do `go` | | version | `v1.12.1` | A versão do `go` |
| symbol | | Espelha o valor da opção `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Espelha o valor da opção `style` | | 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 *: Esta variável só pode ser usada como parte de uma string de estilo
@ -1894,6 +1913,15 @@ O módulo `golang` exibe a versão instalada atual do [Go](https://golang.org/).
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ O módulo `nodejs` exibe a versão atual instalada do [Node.js](https://nodejs.o
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ---------- | --------------------------------- | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | A versão do `node` | | version | `v13.12.0` | A versão do `node` |
| symbol | | Espelha o valor da opção `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Espelha o valor da opção `style` | | 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 *: Esta variável só pode ser usada como parte de uma string de estilo
@ -2920,7 +2949,7 @@ Windows = "🪟 "
| --------- | ------------ | ------------------------------------------------------------------ | | --------- | ------------ | ------------------------------------------------------------------ |
| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` | | symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |
| name | `Arch Linux` | The current operating system name | | name | `Arch Linux` | The current operating system name |
| type | `Arch` | The current operating system type | | tipo | `Arch` | The current operating system type |
| codename | | The current operating system codename, if applicable | | codename | | The current operating system codename, if applicable |
| edition | | The current operating system edition, if applicable | | edition | | The current operating system edition, if applicable |
| version | | The current operating system version, if applicable | | version | | The current operating system version, if applicable |
@ -3565,7 +3594,7 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ O módulo `singularity` exibe a imagem atual do [Singularity](https://sylabs.io/
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Opções
| Opções | Padrão | Descrição |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold blue"` | O estilo do módulo. |
| `disabled` | `false` | Disables this module. |
### Variáveis
| Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Exemplo
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
O módulo `spack` mostra o ambiente [Spack](https://spack.readthedocs.io/en/latest/) atual, se o `$SPACK_ENV` estiver definido. O módulo `spack` mostra o ambiente [Spack](https://spack.readthedocs.io/en/latest/) atual, se o `$SPACK_ENV` estiver definido.

2
docs/pt-BR/faq/README.md
View File

@ -80,7 +80,7 @@ env STARSHIP_LOG=trace starship timings
Isto vai retornar o rastreamento do log e um detalhamento de todos os módulos que levam mais que 1ms para executar ou produzir alguma saída. Isto vai retornar o rastreamento do log e um detalhamento de todos os módulos que levam mais que 1ms para executar ou produzir alguma saída.
Finally if you find a bug you can use the `bug-report` command to create a GitHub issue. Por fim se você encontrar um bug use o comando `bug-report` para criar um GitHub issue.
```sh ```sh
starship bug-report starship bug-report

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

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -169,7 +177,7 @@
### Pré-requisitos ### Pré-requisitos
- 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)). - Uma [Nerd Font](https://www.nerdfonts.com/) instalada e ativa em seu terminal (por exemplo, tente a [ FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)).
### 1º passo. Instalar o Starship ### 1º passo. Instalar o Starship
@ -249,7 +257,7 @@ Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
<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). Instale a ultima versão para o seu sistema usando MSI-installer a partir da [seção de lançamentos](https://github.com/starship/starship/releases/latest).
Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
@ -263,7 +271,7 @@ Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
</details> </details>
### 2º passo. Configure seu shell para usar o Starship ### 2º passo. Configure seu shell para usar Starship
Configure seu shell para inicializar o starship. Selecione o seu na lista abaixo: Configure seu shell para inicializar o starship. Selecione o seu na lista abaixo:
@ -327,7 +335,7 @@ 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): Adicione o seguinte ao final do seu arquivo env do Nushell (enconte-o rodando `$nu.env-path` no Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -420,7 +428,7 @@ Por favor, confira esses trabalhos anteriores que ajudaram a inspirar a criaçã
Apoie este projeto [tornando-se um patrocinador](https://github.com/sponsors/starship). O seu nome ou logotipo aparecerá aqui com um link para o seu site. Apoie este projeto [tornando-se um patrocinador](https://github.com/sponsors/starship). O seu nome ou logotipo aparecerá aqui com um link para o seu site.
**Supporter Tier** **Rank de Apoiadores**
- [Appwrite](https://appwrite.io/) - [Appwrite](https://appwrite.io/)

18
docs/pt-BR/presets/README.md
View File

@ -10,17 +10,17 @@ Essa predefinição altera os símbolos para cada módulo usar símbolos com Ner
[![Captura de tela da personalização com símbolos usando Nerd Font](/presets/img/nerd-font-symbols.png "Clique para ver as personalizações para Nerd Font")](./nerd-font) [![Captura de tela da personalização com símbolos usando Nerd Font](/presets/img/nerd-font-symbols.png "Clique para ver as personalizações para Nerd Font")](./nerd-font)
## [No Nerd Fonts](./no-nerd-font.md) ## [Sem 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. Essa predefinição altera os símbolos para vários módulos para que nenhum utilize símbolos das Nerd Fonts em nenhum lugar no prompt.
::: tip ::: tip
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). Esta predefinição se tornará padrão em [uma futura release do starship](https://github.com/starship/starship/pull/3544).
::: :::
[Click to view No Nerd Font preset](./no-nerd-font) [Clique para visualizar a predefinição de sem Nerd Font](./no-nerd-font)
## [Seguimentos entre colchetes](./bracketed-segments.md) ## [Seguimentos entre colchetes](./bracketed-segments.md)
@ -40,11 +40,11 @@ Esta predefinição oculta a versão do runtime da linguagem. Se você trabalha
[![Captura de tela de uma personalização ocultando a versão do runtime](/presets/img/no-runtime-versions.png "Clique para ver as personalizações para remover a versão do runtime")](./no-runtimes) [![Captura de tela de uma personalização ocultando a versão do runtime](/presets/img/no-runtime-versions.png "Clique para ver as personalizações para remover a versão do runtime")](./no-runtimes)
## [No Empty Icons](./no-empty-icons.md) ## [Sem Ícones Vazios](./no-empty-icons.md)
This preset does not show icons if the toolset is not found. Este preset não mostra ícones se as ferramentas não forem encontradas.
[![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png "Clique para ver as personalizações para remover a versão do runtime")](./no-empty-icons.md) [![Captura de tela de preset de nenhum ícone vazio](/presets/img/no-empty-icons.png "Clique para ver as personalizações para remover a versão do runtime")](./no-empty-icons.md)
## [Prompt do Terminal com Pure](./pure-preset.md) ## [Prompt do Terminal com Pure](./pure-preset.md)
@ -60,6 +60,6 @@ Esta personalização é inspirada em [M365Princess](https://github.com/JanDeDob
## [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 é inspirado por [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 de tela de Tokyo Night preset](/presets/img/tokyo-night.png "Clique para visualizar Tokyo Night preset")](./tokyo-night)

6
docs/pt-BR/presets/no-empty-icons.md
View File

@ -1,10 +1,10 @@
[Retornar para Personalizações](./README.md#no-empty-icons) [Retornar para Personalizações](./README.md#no-empty-icons)
# No Empty Icons Preset # Predefinição Nenhum Ícones Vazios
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. Se os arquivos de toolset forem encontrados o ícone do toolset será exibido. Se um toolset não for encontrado para determinar o número da versão, ele não será exibido. Esta predefinição altera o comportamento para que o ícone seja exibido somente se a informação do toolset puder ser determinada.
![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png) ![Captura de tela da predefinição de nenhum ícone vazio](/presets/img/no-empty-icons.png)
### Configuração ### Configuração

8
docs/pt-BR/presets/no-nerd-font.md
View File

@ -1,12 +1,12 @@
[Retornar para Personalizações](./README.md#no-nerd-fonts) [Retornar para Personalizações](./README.md#no-nerd-fonts)
# No Nerd Fonts Preset # Predefinição sem Nerd Fonts
This preset restricts the use of symbols to those from emoji and powerline sets. Esta predefinição restringe o uso de conjunto de símbolos de emoji e powerline.
This means that even without a Nerd Font installed, you should be able to view all module symbols. Isto significa que sem uma Nerd Font instalada, você consiguirá visualizar todos os símbolos dos módulos.
This preset will become the default preset in a future release of starship. Esta predefinição será padrão em uma futrura release do starship.
### Configuração ### Configuração

6
docs/pt-BR/presets/tokyo-night.md
View File

@ -1,10 +1,10 @@
[Retornar para Personalizações](./README.md#pastel-powerline) [Retornar para Personalizações](./README.md#pastel-powerline)
# Tokyo Night Preset # Predifinição Tokyo Night
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme). Esta predefinição é inspirado por [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png) ![Captura de tala da predefinissão Tokyo Night preset](/presets/img/tokyo-night.png)
### Pré-requisitos ### Pré-requisitos

2
docs/pt-PT/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

137
docs/pt-PT/config/README.md
View File

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description | | Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. | | `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. | | `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Example
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.

10
docs/pt-PT/guide/README.md
View File

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Step 2. Setup your shell to use Starship ### Step 2. Set up your shell to use Starship
Configure your shell to initialize starship. Select yours from the list below: Configure your shell to initialize starship. Select yours from the list below:

2
docs/ru-RU/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

139
docs/ru-RU/config/README.md
View File

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Опции ### Опции
| Переменная | По умолчанию | Описание | | Переменная | По умолчанию | Описание |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Примеры ### Примеры
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Батарея ## Батарея
Модуль `battery` показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%. Модуль `battery` показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%.
@ -467,11 +478,11 @@ style = "blue bold"
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| -------------------- | --------------------------------- | ------------------------------------------------------- | | -------------------- | --------------------------------- | ------------------------------------------------------- |
| `full_symbol` | `' '` | Символ, отображаемый при полной батарее. | | `full_symbol` | `'󰁹 '` | Символ, отображаемый при полной батарее. |
| `charging_symbol` | `' '` | Символ, показываемый при зарядке аккумулятора. | | `charging_symbol` | `'󰂄 '` | Символ, показываемый при зарядке аккумулятора. |
| `discharging_symbol` | `' '` | Символ, показываемый при разрядке аккумулятора. | | `discharging_symbol` | `'󰂃 '` | Символ, показываемый при разрядке аккумулятора. |
| `unknown_symbol` | `' '` | Символ, отображаемый при неизвестном состоянии батареи. | | `unknown_symbol` | `'󰁽 '` | Символ, отображаемый при неизвестном состоянии батареи. |
| `empty_symbol` | `' '` | Символ, отображаемый при пустом состоянии батареи. | | `empty_symbol` | `'󰂎 '` | Символ, отображаемый при пустом состоянии батареи. |
| `format` | `'[$symbol$percentage]($style) '` | Формат модуля. | | `format` | `'[$symbol$percentage]($style) '` | Формат модуля. |
| `display` | [ссылка](#battery-display) | Порог отображения и стиль для модуля. | | `display` | [ссылка](#battery-display) | Порог отображения и стиль для модуля. |
| `disabled` | `false` | Отключает модуль `battery`. | | `disabled` | `false` | Отключает модуль `battery`. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Стиль модуля. | | `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Переменные ### Переменные
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Стиль модуля. | | `style` | `'bold red'` | Стиль модуля. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Отключает модуль `git_status`. | | `disabled` | `false` | Отключает модуль `git_status`. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Отражает значение параметра `style` | | style\* | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | | `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | Стиль модуля. | | `style` | `'bold cyan'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `golang`. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Отключает модуль `golang`. |
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Отражает значение параметра `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Отражает значение параметра `style` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Отражает значение параметра `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Отражает значение параметра `style` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -3565,7 +3594,7 @@ The `shell` module shows an indicator for currently used shell.
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | Стиль модуля. |
| `disabled` | `false` | Disables this module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4162,7 +4229,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `описание` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

10
docs/ru-RU/guide/README.md
View File

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Шаг 2. Setup your shell to use Starship ### Шаг 2. Set up your shell to use Starship
Configure your shell to initialize starship. Select yours from the list below: Configure your shell to initialize starship. Select yours from the list below:

2
docs/tr-TR/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

137
docs/tr-TR/config/README.md
View File

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `stil` | `'blue bold'` | The style used in the format. | | `stil` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description | | Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- | | -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. | | `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. | | `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. | | `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. | | `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. | | `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. | | `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. | | `disabled` | `false` | Disables the `battery` module. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `stil` | `'bold blue'` | The style for the module. | | `stil` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `stil` | `'bold red'` | The style for the module. | | `stil` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `stil` | `'bold cyan'` | The style for the module. | | `stil` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `stil` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables this module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### Example
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.

10
docs/tr-TR/guide/README.md
View File

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Rusça" alt="Rusça"
/></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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Starship'i herhangi bir paket yöneticisi ile yükleyin:
</details> </details>
### 2. Adım Shell'inizi Starship kullanmaya hazır hale getirin ### 2. Adım Set up your shell to use Starship
Shell'ı starshiple çalışması için ayarla. Aşağıdaki listeden shell'inizi seçin: Shell'ı starshiple çalışması için ayarla. Aşağıdaki listeden shell'inizi seçin:

2
docs/uk-UA/advanced-config/README.md
View File

@ -193,7 +193,7 @@ load(io.popen('starship init cmd'):read("*a"))()
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

175
docs/uk-UA/config/README.md
View File

@ -242,7 +242,7 @@ mustard = '#af8700'
```toml ```toml
format = '$all' format = '$all'
# Є еквівалентом # Є тотожним
format = """ format = """
$username\ $username\
$hostname\ $hostname\
@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
Модуль `aws` показує поточний регіон AWS і профіль, а також час, що залишився до кінця сесії при використанні тимчасових облікових даних. Для виводу модуль використовує змінні `AWS_REGION`, `AWS_DEFAULT_REGION` і `AWS_PROFILE` та файли `~/.aws/config` і `~/.aws/credentials`, коли треба. Модуль `aws` показує поточний регіон AWS і профіль, а також час, що залишився до кінця сесії при використанні тимчасових облікових даних. Для виводу модуль використовує змінні `AWS_REGION`, `AWS_DEFAULT_REGION` і `AWS_PROFILE` та файли `~/.aws/config` і `~/.aws/credentials`, коли треба.
Модуль буде показуватиме профіль лише в тому випадку, якщо облікові дані знаходяться в `~/.aws/credentials` або якщо `credential_process` чи `sso_start_url` визначені в `~/.aws/config`. Крім того, достатньо буде визначити будь-яку змінну `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` або `AWS_SESSION_TOKEN`. Якщо для параметра `force_display` встановлено значення `true`, уся доступна інформація буде показуватись, навіть якщо не буде виявлено жодних облікових даних відповідно до наведених вище умов. Модуль показуватиме профіль якщо облікові дані знаходяться в `~/.aws/credentials` або коли `credential_process`, `sso_start_url`, чи `sso_session` визначені в `~/.aws/config`. Крім того, достатньо буде визначити будь-яку змінну `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` або `AWS_SESSION_TOKEN`. Якщо для параметра `force_display` встановлено значення `true`, уся доступна інформація буде показуватись, навіть якщо не буде виявлено жодних облікових даних відповідно до наведених вище умов.
Під час використання [aws-vault](https://github.com/99designs/aws-vault) профіль зчитується зі змінної `AWS_VAULT`, а дата закінчення терміну дії облікових даних зчитується зі змінної `AWS_SESSION_EXPIRATION`. Під час використання [aws-vault](https://github.com/99designs/aws-vault) профіль зчитується зі змінної `AWS_VAULT`, а дата закінчення терміну дії облікових даних зчитується зі змінної `AWS_SESSION_EXPIRATION`.
@ -426,12 +427,13 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
### Параметри ### Параметри
| Змінна | Стандартно | Опис | | Змінна | Стандартно | Опис |
| ---------- | ---------------------------------------- | ------------------------------ | | ---------------------- | ---------------------------------------- | -------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | Формат для модуля Azure. | | `format` | `'on [$symbol($subscription)]($style) '` | Формат для модуля Azure. |
| `symbol` | `'ﴃ '` | Символ, який використовується. | | `symbol` | `'󰠅 '` | Символ, який використовується. |
| `style` | `'blue bold'` | Стиль, який використовується. | | `style` | `'blue bold'` | Стиль, який використовується. |
| `disabled` | `true` | Вимикає модуль `azure`. | | `disabled` | `true` | Вимикає модуль `azure`. |
| `subscription_aliases` | `{}` | Таблиця псевдонімів підписки для показу на додачу до назви підписки Azure. |
### Приклади ### Приклади
@ -443,7 +445,7 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Показ псевдонімів підписки
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
Модуль `battery` показує наскільки заряджена батарея пристрою і стан заряджання. Модуль показується лише тоді, коли заряд акумулятора пристрою нижче 10%. Модуль `battery` показує наскільки заряджена батарея пристрою і стан заряджання. Модуль показується лише тоді, коли заряд акумулятора пристрою нижче 10%.
@ -467,11 +478,11 @@ style = "blue bold"
| Параметр | Стандартно | Опис | | Параметр | Стандартно | Опис |
| -------------------- | --------------------------------- | ------------------------------------ | | -------------------- | --------------------------------- | ------------------------------------ |
| `full_symbol` | `' '` | Символ, повного заряду батареї. | | `full_symbol` | `'󰁹 '` | Символ, повного заряду батареї. |
| `charging_symbol` | `' '` | Символ процесу заряджання. | | `charging_symbol` | `'󰂄 '` | Символ процесу заряджання. |
| `discharging_symbol` | `' '` | Символ, коли батарея розряджається. | | `discharging_symbol` | `'󰂃 '` | Символ, коли батарея розряджається. |
| `unknown_symbol` | `' '` | Символ, коли стан батареї невідомий. | | `unknown_symbol` | `'󰁽 '` | Символ, коли стан батареї невідомий. |
| `empty_symbol` | `' '` | Символ повністю розрядженої батареї. | | `empty_symbol` | `'󰂎 '` | Символ повністю розрядженої батареї. |
| `format` | `'[$symbol$percentage]($style) '` | Формат модуля. | | `format` | `'[$symbol$percentage]($style) '` | Формат модуля. |
| `display` | [link](#battery-display) | Граничні значення і стиль модуля. | | `display` | [link](#battery-display) | Граничні значення і стиль модуля. |
| `disabled` | `false` | Вимикає модуль `battery`. | | `disabled` | `false` | Вимикає модуль `battery`. |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
Модуль `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`.
Коли модуль увімкнено, він завжди буде активним, якщо не встановлено параметр `detect_env_vars`, в такому випадку модуль буде активним лише коли буде встановлено одну зі змінних середовища.
### Параметри ### Параметри
| Параметр | Стандартно | Опис | | Параметр | Стандартно | Опис |
@ -1525,6 +1538,7 @@ truncation_symbol = ''
| `symbol` | `'☁️ '` | Символ, який використовується під час показу перед поточним профілем GCP. | | `symbol` | `'☁️ '` | Символ, який використовується під час показу перед поточним профілем GCP. |
| `region_aliases` | `{}` | Таблиця псевдонімів регіону для показу на додачу до назви GCP. | | `region_aliases` | `{}` | Таблиця псевдонімів регіону для показу на додачу до назви GCP. |
| `project_aliases` | `{}` | Таблиця псевдонімів проєкту для показу на додачу до назви GCP. | | `project_aliases` | `{}` | Таблиця псевдонімів проєкту для показу на додачу до назви GCP. |
| `detect_env_vars` | `[]` | Які змінні середовища повинні запускати цей модуль |
| `style` | `'bold blue'` | Стиль модуля. | | `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `gcloud`. | | `disabled` | `false` | Вимикає модуль `gcloud`. |
@ -1630,7 +1644,7 @@ ignore_branches = ['master', 'main']
## Git Commit ## Git Commit
Модуль `git_commit` показує поточний хеш коміту, а також теґ (якщо такі є) репозиторію у вашій поточній теці. Модуль `git_commit` показує поточний хеш коміту, а також теґ (якщо він є) репозиторію у вашій поточній теці.
### Параметри ### Параметри
@ -1667,7 +1681,7 @@ tag_symbol = '🔖 '
## Git State ## Git State
Модуль `git_state` показуватиметься в теках, які є частиною репозиторію git і де виконуються операції, такі як: _REBASING_, _BISECTING</1 > тощо. Якщо є інформація про прогрес (наприклад, REBASING 3/10), ця інформація також буде показана.</p> Модуль `git_state` показується в теках, які є частиною репозиторію git, під час виконання операцій на зразок _REBASING_, _BISECTING</1 > тощо. Інформація про прогрес операції (наприклад, REBASING 3/10), також буде показана якщо вона доступна.</p>
### Параметри ### Параметри
@ -1711,7 +1725,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
::: :::
@ -1724,6 +1738,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
| `only_nonzero_diffs` | `true` | Показувати стан лише для змінених елементів. | | `only_nonzero_diffs` | `true` | Показувати стан лише для змінених елементів. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. |
| `disabled` | `true` | Вимикає модуль `git_metrics`. | | `disabled` | `true` | Вимикає модуль `git_metrics`. |
| `ignore_submodules` | `false` | Ігнорувати зміни в субмодулях |
### Змінні ### Змінні
@ -1748,11 +1763,11 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
## Git Status ## Git Status
Модуль `git_status` показує символ, що представляє стан репозиторію в поточній теці. Модуль `git_status` показує символ, що описує стан репозиторію в поточній теці.
::: tip ::: tip
Модуль Git Status дуже повільно працює в теках Windows (наприклад, під `/mnt/c/`) у WSL середовищі. Ви можете вимкнути модуль або використати `windows_starship` для використання Windows-native Starship `git_status` для цих шляхів. Модуль Git Status дуже повільно працює в теках Windows у середовищі WSL (наприклад, під `/mnt/c/`). Ви можете вимкнути модуль або використати `windows_starship` для використання Windows-native Starship `git_status` для цих шляхів.
::: :::
@ -1772,6 +1787,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
| `staged` | `'+'` | Формат `staged` | | `staged` | `'+'` | Формат `staged` |
| `renamed` | `'»'` | Формат `renamed` | | `renamed` | `'»'` | Формат `renamed` |
| `deleted` | `'✘'` | Формат `deleted` | | `deleted` | `'✘'` | Формат `deleted` |
| `typechanged` | `""` | Формат `typechange` |
| `style` | `'bold red'` | Стиль модуля. | | `style` | `'bold red'` | Стиль модуля. |
| `ignore_submodules` | `false` | Ігнорувати зміни в субмодулях. | | `ignore_submodules` | `false` | Ігнорувати зміни в субмодулях. |
| `disabled` | `false` | Вимикає модуль `git_status`. | | `disabled` | `false` | Вимикає модуль `git_status`. |
@ -1792,6 +1808,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
| `staged` | Показує `staged`, коли нові фали були додані до простору staging. | | `staged` | Показує `staged`, коли нові фали були додані до простору staging. |
| `renamed` | Показує `renamed` коли перейменовані файли було додано до простору staging. | | `renamed` | Показує `renamed` коли перейменовані файли було додано до простору staging. |
| `deleted` | Показує `deleted` коли інформація про видалення файлів була додана до простору staging. | | `deleted` | Показує `deleted` коли інформація про видалення файлів була додана до простору staging. |
| `typechanged` | Показує `typechange` коли інформація про файл була змінена у просторі staging. |
| style\* | Віддзеркалює значення параметра `style` | | style\* | Віддзеркалює значення параметра `style` |
*: Ця змінна може бути використана лише як частина стилю рядка *: Ця змінна може бути використана лише як частина стилю рядка
@ -1864,24 +1881,26 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e
### Параметри ### Параметри
| Параметр | Стандартно | Опис | | Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | | `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` | | `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` |
| `symbol` | `'🐹 '` | Формат рядка, що представляє символ Go. | | `symbol` | `'🐹 '` | Формат рядка, що представляє символ Go. |
| `detect_extensions` | `['go']` | Які розширення повинні запускати цей модуль. | | `detect_extensions` | `['go']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Які імена файлів мають запускати цей модуль. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `['Godeps']` | В яких теках цей модуль має запускатись. | | `detect_folders` | `['Godeps']` | В яких теках цей модуль має запускатись. |
| `style` | `'bold cyan'` | Стиль модуля. | | `style` | `'bold cyan'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `golang`. | | `not_capable_style` | `'bold red'` | Стиль модуля, коли директиви go з файлу go.mod не збігаються з встановленою версією Go. |
| `disabled` | `false` | Вимикає модуль `golang`. |
### Змінні ### Змінні
| Змінна | Приклад | Опис | | Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | Версія `go` | | version | `v1.12.1` | Версія `go` |
| symbol | | Віддзеркалює значення параметра `symbol` | | mod_version | `1.16` | вимоги до версії `go`, як зазначено у директиві `go.mod`. Буде показано лише коли потрібна версія не збігається з версією `go`. |
| style\* | | Віддзеркалює значення параметра `style` | | symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
*: Ця змінна може бути використана лише як частина стилю рядка *: Ця змінна може бути використана лише як частина стилю рядка
@ -1894,6 +1913,15 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Використання `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
Модуль `guix_shell` показує середовище [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html). Модуль буде показано, коли ви перебуваєте в середовищі guix-shell. Модуль `guix_shell` показує середовище [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html). Модуль буде показано, коли ви перебуваєте в середовищі guix-shell.
@ -2299,7 +2327,7 @@ kotlin_binary = 'kotlinc'
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
Коли модуль увімкнено, він завжди буде активним, якщо будь-який з параметрів `detect_extensions`, `detect_files` або `detect_folders` встановлені, модуль буде активним тільки в теках, що відповідають умовам. Коли модуль увімкнено, він завжди буде активним, якщо будь-який з параметрів `detect_extensions`, `detect_files` або `detect_folders` встановлені, модуль буде активним тільки в теках, що відповідають умовам.
@ -2481,7 +2509,7 @@ format = 'via [🌕 $version](bold blue) '
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
::: :::
@ -2706,11 +2734,12 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
### Змінні ### Змінні
| Змінна | Приклад | Опис | | Змінна | Приклад | Опис |
| --------- | ---------- | ---------------------------------------- | | --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | Версія `node` | | version | `v13.12.0` | Версія `node` |
| symbol | | Віддзеркалює значення параметра `symbol` | | engines_version | `>=12.0.0` | вимоги до версії `node`, як зазначено в описі `package.json`. Буде показано лише коли потрібна версія не збігається з версією `node`. |
| style\* | | Віддзеркалює значення параметра `style` | | symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
*: Ця змінна може бути використана лише як частина стилю рядка *: Ця змінна може бути використана лише як частина стилю рядка
@ -2853,7 +2882,7 @@ symbol = '☁️ '
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
::: :::
@ -2945,7 +2974,7 @@ Arch = "Arch is the best! "
## Package Version ## Package Version
Модуль `package` показується, коли поточна тека є сховищем для пакунка, і показує його поточну версію. Наразі модуль підтримує наступні пакунки `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` та `dart`. Модуль `package` показується, коли поточна тека є сховищем для пакунка, і показує його поточну версію. Наразі модуль підтримує такі пакунки: `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart`.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) — версія пакунка `npm` отримується з `package.json` з поточної теки - [**npm**](https://docs.npmjs.com/cli/commands/npm) — версія пакунка `npm` отримується з `package.json` з поточної теки
- [**Cargo**](https://doc.rust-lang.org/cargo/) — версія пакунка `cargo` отримується з `Cargo.toml` з поточної теки - [**Cargo**](https://doc.rust-lang.org/cargo/) — версія пакунка `cargo` отримується з `Cargo.toml` з поточної теки
@ -3098,7 +3127,7 @@ format = 'via [🔹 $version](147 bold) '
::: tip ::: tip
Стандартно версія Pulumi не показується, через те що для цього потрібно набагато більше часу ніж на завантаження більшості втулків (~70ms). Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче](#with-pulumi-version). За замовчуванням, версія Pulumi не показана, тому що отримання версії потребує на порядок більше часу, ніж потрібно іншим плагінам (близько 70мc). Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче](#with-pulumi-version).
::: :::
@ -3527,7 +3556,7 @@ symbol = '🌟 '
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
::: :::
@ -3565,7 +3594,7 @@ symbol = '🌟 '
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ threshold = 3
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
Модуль `solidity` показує поточну версію [Solidity](https://soliditylang.org/) Модуль буде показано, якщо буде вказано якісь з наступних умов:
- Поточна тека містить файл `.sol`
### Параметри
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${major}.${minor}.${patch}"` | Формат версії. Доступні змінні `raw`, `major`, `minor` та `patch` |
| `symbol` | `"S "` | Формат рядка, що представляє символ Solidity |
| `compiler | ["solc"] | Стандартний компілятор Solidity. |
| `detect_extensions` | `["sol"]` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `"bold blue"` | Стиль модуля. |
| `disabled` | `false` | Вмикає цей модуль. |
### Змінні
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
| version | `v0.8.1` | Версія `solidity` |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
*: Ця змінна може бути використана лише як частина стилю рядка
### Приклад
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
Модуль `spack` показує інформацію про поточне оточення [Spack](https://spack.readthedocs.io/en/latest/), якщо змінна `$SPACK_ENV` встановлена. Модуль `spack` показує інформацію про поточне оточення [Spack](https://spack.readthedocs.io/en/latest/), якщо змінна `$SPACK_ENV` встановлена.
@ -3675,11 +3742,11 @@ format = '[$symbol$environment](dimmed blue) '
## Status ## Status
Модуль `status` показує код завершення роботи попередньої команди. Якщо $success_symbol пустий (типово), модуль буде показаний тільки якщо код виходу не `0`. Код status може бути перетворений у 32-бітне ціле число. Модуль `status` показує код завершення роботи попередньої команди. Якщо $success_symbol пустий (типово), модуль буде показаний тільки якщо код виходу не `0`. Код status буде перетворений у 32-бітне ціле число.
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
::: :::
@ -3740,7 +3807,7 @@ disabled = false
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
::: :::
@ -3883,11 +3950,11 @@ format = '[🏎💨 $workspace]($style) '
## Time ## Time
Модуль `time` показує поточний **місцевий** час. Значення `format` використовується в [`chrono`](https://crates.io/crates/chrono) для керування показу часу. Перегляньте [документацію chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), щоб побачити, які параметри доступні. Модуль `time` показує поточний **місцевий** час. Значення `format` використовується крейтом [`chrono`](https://crates.io/crates/chrono) для визначення формату показу часу. Перегляньте [документацію chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), щоб побачити, які параметри доступні.
::: tip ::: tip
Цей модуль типово є вимкненим. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань. За замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
::: :::
@ -3938,7 +4005,7 @@ time_range = '10:00:00-14:00:00'
::: tip ::: tip
Підключення SSH виявляється шляхом перевірки змінних середовища `SSH_CONNECTION`, `SSH_CLIENT` і `SSH_TTY`. Якщо ваш хост SSH не налаштував ці змінні, одним зі способів розвʼязання проблеми є встановлення для однієї з них фіктивного значення. Модуль виявляє підключення SSH перевіряючи змінні середовища `SSH_CONNECTION`, `SSH_CLIENT` і `SSH_TTY`. Якщо ваш хост SSH не налаштував ці змінні, одним зі способів розвʼязання проблеми є встановлення для однієї з них фіктивного значення.
::: :::
@ -4162,7 +4229,7 @@ symbol = '⚡️ '
| `when` | `false` | Або булеве значення (`true` чи `false`, без лапок) або команди shell, що використовуються як умова для показу модуля. У випадку рядка команди, модуль буде показаний, якщо команда повертає код завершення `0`. | | `when` | `false` | Або булеве значення (`true` чи `false`, без лапок) або команди shell, що використовуються як умова для показу модуля. У випадку рядка команди, модуль буде показаний, якщо команда повертає код завершення `0`. |
| `require_repo` | `false` | Якщо `true`, модуль буде показано лише в шляхах, що містять репозиторій (git). Цей параметр сам по собі не є достатньою умовою для показу модуля за відсутності інших варіантів. | | `require_repo` | `false` | Якщо `true`, модуль буде показано лише в шляхах, що містять репозиторій (git). Цей параметр сам по собі не є достатньою умовою для показу модуля за відсутності інших варіантів. |
| `shell` | | [Дивіться нижче](#custom-command-shell) | | `shell` | | [Дивіться нижче](#custom-command-shell) |
| `description` | `'<custom module>'` | Опис модуля, який показується під час запуску `starship explain`. | | `опис` | `'<custom module>'` | Опис модуля, який показується під час запуску `starship explain`. |
| `detect_files` | `[]` | Файли, які треба шукати у робочій теці для отримання збігу. | | `detect_files` | `[]` | Файли, які треба шукати у робочій теці для отримання збігу. |
| `detect_folders` | `[]` | Теки, які треба шукати у робочій теці для отримання збігу. | | `detect_folders` | `[]` | Теки, які треба шукати у робочій теці для отримання збігу. |
| `detect_extensions` | `[]` | Розширення файлів, які треба шукати у робочій теці для отримання збігу. | | `detect_extensions` | `[]` | Розширення файлів, які треба шукати у робочій теці для отримання збігу. |

12
docs/uk-UA/guide/README.md
View File

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -171,7 +179,7 @@
- Встановлений та увімкнений у Вашому терміналі набір шрифтів [Nerd Font](https://www.nerdfonts.com/) (для прикладу, спробуйте [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - Встановлений та увімкнений у Вашому терміналі набір шрифтів [Nerd Font](https://www.nerdfonts.com/) (для прикладу, спробуйте [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
### Крок 1. Встановлення starship ### Крок 1. Встановіть Starship
Оберіть Вашу операційну систему зі списку нижче, щоб переглянути інструкцію зі встановлення: Оберіть Вашу операційну систему зі списку нижче, щоб переглянути інструкцію зі встановлення:
@ -263,7 +271,7 @@ curl -sS https://starship.rs/install.sh | sh
</details> </details>
### Крок 2. Налаштуйте Вашу оболонку для використання starship ### Крок 2. Налаштуйте оболонку для використання Starship
Налаштуйте свою оболонку, щоб ініціалізувати starship. Виберіть ваш варіант зі списку: Налаштуйте свою оболонку, щоб ініціалізувати starship. Виберіть ваш варіант зі списку:

2
docs/vi-VN/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

143
docs/vi-VN/config/README.md
View File

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Các tuỳ chọn ### Các tuỳ chọn
| Biến | Mặc định | Mô tả | | Biến | Mặc định | Mô tả |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Các ví dụ ### Các ví dụ
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery ## Battery
`battery` module cho biết cách sạc pin của thiết bị là gì và tình trạng sạc hiện tại của nó. Module chỉ được nhìn thấy khi pin của thiết bị dưới 10%. `battery` module cho biết cách sạc pin của thiết bị là gì và tình trạng sạc hiện tại của nó. Module chỉ được nhìn thấy khi pin của thiết bị dưới 10%.
@ -467,11 +478,11 @@ style = "blue bold"
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | --------------------------------- | -------------------------------------------------------- | | -------------------- | --------------------------------- | -------------------------------------------------------- |
| `full_symbol` | `' '` | Kí hiệu cho biết khi pin đầy. | | `full_symbol` | `'󰁹 '` | Kí hiệu cho biết khi pin đầy. |
| `charging_symbol` | `' '` | Kí hiệu cho biết khi ping đang sạc. | | `charging_symbol` | `'󰂄 '` | Kí hiệu cho biết khi ping đang sạc. |
| `discharging_symbol` | `' '` | Kí hiệu cho biết khi pin đang không sạc. | | `discharging_symbol` | `'󰂃 '` | Kí hiệu cho biết khi pin đang không sạc. |
| `unknown_symbol` | `' '` | Kí hiệu cho biết khi trạng thái pin không được xác định. | | `unknown_symbol` | `'󰁽 '` | Kí hiệu cho biết khi trạng thái pin không được xác định. |
| `empty_symbol` | `' '` | Kí hiệu cho biết khi hết pin. | | `empty_symbol` | `'󰂎 '` | Kí hiệu cho biết khi hết pin. |
| `format` | `'[$symbol$percentage]($style) '` | Định dạng cho module. | | `format` | `'[$symbol$percentage]($style) '` | Định dạng cho module. |
| `display` | [link](#battery-display) | Ngưỡng hiển thị và kiểu cho module. | | `display` | [link](#battery-display) | Ngưỡng hiển thị và kiểu cho module. |
| `disabled` | `false` | Vô hiệu `battery` module. | | `disabled` | `false` | Vô hiệu `battery` module. |
@ -499,7 +510,7 @@ style = 'bold red'
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option. The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
#### Options #### Các tuỳ chọn
Tuỳ chọn `display` là một mảng của của bảng sau. Tuỳ chọn `display` là một mảng của của bảng sau.
@ -1517,6 +1528,8 @@ truncation_symbol = ''
Mô đun `gcloud` hiển thị cấu hình hiện tại của [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. Cái này dựa trên tập tin `~/.config/gcloud/active_config`, `~/.config/gcloud/configurations/config_{CONFIG NAME}` và biến môi trường `CLOUDSDK_CONFIG`. Mô đun `gcloud` hiển thị cấu hình hiện tại của [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. Cái này dựa trên tập tin `~/.config/gcloud/active_config`, `~/.config/gcloud/configurations/config_{CONFIG NAME}` và biến môi trường `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.
### Options ### Options
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
@ -1525,6 +1538,7 @@ Mô đun `gcloud` hiển thị cấu hình hiện tại của [`gcloud`](https:/
| `symbol` | `'☁️ '` | Kí hiệu sử dụng hiển thị trước profile GCP hiện tại. | | `symbol` | `'☁️ '` | Kí hiệu sử dụng hiển thị trước profile GCP hiện tại. |
| `region_aliases` | `{}` | Bảng ánh xạ của các bí danh của region để hiển thị ngoài tên GCP. | | `region_aliases` | `{}` | Bảng ánh xạ của các bí danh của region để hiển thị ngoài tên GCP. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Kiểu cho module. | | `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `gcloud`. | | `disabled` | `false` | Vô hiệu mô đun `gcloud`. |
@ -1724,6 +1738,7 @@ Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiế
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Định dạng cho module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Định dạng cho module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Các biến ### Các biến
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | Định dạng của `modified` | | `staged` | `'+'` | Định dạng của `modified` |
| `renamed` | `'»'` | Định dạng của `renamed` | | `renamed` | `'»'` | Định dạng của `renamed` |
| `deleted` | `'✘'` | Định dạng của `deleted` | | `deleted` | `'✘'` | Định dạng của `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Kiểu cho module. | | `style` | `'bold red'` | Kiểu cho module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Vô hiệu `git_status` module. | | `disabled` | `false` | Vô hiệu `git_status` module. |
@ -1792,6 +1808,7 @@ Các biến dưới đây có thể được sử dụng trong `format`:
| `staged` | Hiển thị `staged` khi một tệp tin mới được thêm vào staging area. | | `staged` | Hiển thị `staged` khi một tệp tin mới được thêm vào staging area. |
| `renamed` | Hiển thị `renamed` khi một tệp tin đổi tên đã được thêm vào staging area. | | `renamed` | Hiển thị `renamed` khi một tệp tin đổi tên đã được thêm vào staging area. |
| `deleted` | Hiển thị `deleted` khi một tệp tin bị xóa đã được thêm vào staging area. | | `deleted` | Hiển thị `deleted` khi một tệp tin bị xóa đã được thêm vào staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Giá trị ghi đè của `style` | | style\* | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string *: Biến này có thể chỉ được sử dụng như một phần của style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | | `format` | `'via [$symbol($version )]($style)'` | Định dạng cho 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` | `'🐹 '` | Một format string đại diện cho biểu tượng của Go. | | `symbol` | `'🐹 '` | Một format string đại diện cho biểu tượng của Go. |
| `detect_extensions` | `['go']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_extensions` | `['go']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `['Godeps']` | Những thư mục nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `['Godeps']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `'bold cyan'` | Kiểu cho module. | | `style` | `'bold cyan'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `golang` module. | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Vô hiệu `golang` module. |
### Các biến ### Các biến
| Biến | Ví dụ | Mô tả | | Biến | Ví dụ | Mô tả |
| --------- | --------- | -------------------------------- | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | Phiên bản của `go` | | version | `v1.12.1` | Phiên bản của `go` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Giá trị ghi đè của `style` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string *: Biến này có thể chỉ được sử dụng như một phần của style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2252,7 +2280,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
- Thư mục hiện tại chứa một tệp tin `.kt` hoặc một tệp tin `.kts` - Thư mục hiện tại chứa một tệp tin `.kt` hoặc một tệp tin `.kts`
### Options ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Các biến ### Các biến
| Biến | Ví dụ | Mô tả | | Biến | Ví dụ | Mô tả |
| --------- | ---------- | -------------------------------- | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Giá trị ghi đè của `style` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string *: Biến này có thể chỉ được sử dụng như một phần của style string
@ -3565,7 +3594,7 @@ Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiế
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold blue"` | Kiểu cho module. |
| `disabled` | `false` | Disables this module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v0.8.1` | The version of `solidity` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
### Ví dụ
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4162,7 +4229,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `mô tả` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

10
docs/vi-VN/guide/README.md
View File

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Tiếng Nga" alt="Tiếng Nga"
/></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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Step 2. Setup your shell to use Starship ### Step 2. Set up your shell to use Starship
Configure your shell to initialize starship. Select yours from the list below: Configure your shell to initialize starship. Select yours from the list below:

2
docs/zh-CN/advanced-config/README.md
View File

@ -193,7 +193,7 @@ load(io.popen('starship init cmd'):read("*a"))()
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

531
docs/zh-CN/config/README.md
View File

File diff suppressed because it is too large Load Diff

10
docs/zh-CN/guide/README.md
View File

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Pусский" alt="Pусский"
/></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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ curl -sS https://starship.rs/install.sh | sh
</details> </details>
### 步骤 2. 设置你的终端以使用 Starship ### 步骤 2. Set up your shell to use Starship
配置你的终端来初始化 starship。 请从下面列表选择你的终端： 配置你的终端来初始化 starship。 请从下面列表选择你的终端：

2
docs/zh-TW/advanced-config/README.md
View File

@ -193,7 +193,7 @@ You can also set a similar output with PowerShell by creating a function named `
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
$host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
} }
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

139
docs/zh-TW/config/README.md
View File

@ -298,6 +298,7 @@ $red\
$ruby\ $ruby\
$rust\ $rust\
$scala\ $scala\
$solidity\
$swift\ $swift\
$terraform\ $terraform\
$vlang\ $vlang\
@ -340,7 +341,7 @@ format = '$all$directory$character'
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### 選項 ### 選項
| 變數 | 預設 | 說明 | | 變數 | 預設 | 說明 |
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. | | `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. | | `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. | | `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples ### Examples
@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure] [azure]
disabled = false disabled = false
format = 'on [$symbol($subscription)]($style) ' format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ ' symbol = '󰠅 '
style = 'blue bold' style = 'blue bold'
``` ```
@ -455,10 +457,19 @@ style = 'blue bold'
[azure] [azure]
disabled = false disabled = false
format = "on [$symbol($username)]($style) " format = "on [$symbol($username)]($style) "
symbol = "ﴃ " symbol = "󰠅 "
style = "blue bold" style = "blue bold"
``` ```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## 電池 ## 電池
`battery` 模組顯示電池的電量以及現在的充電狀態。 這個模組只會在裝置的電量低於 10% 的時候看見。 `battery` 模組顯示電池的電量以及現在的充電狀態。 這個模組只會在裝置的電量低於 10% 的時候看見。
@ -467,11 +478,11 @@ style = "blue bold"
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| -------------------- | --------------------------------- | -------------------------- | | -------------------- | --------------------------------- | -------------------------- |
| `full_symbol` | `' '` | 當電池充飽時顯示的符號。 | | `full_symbol` | `'󰁹 '` | 當電池充飽時顯示的符號。 |
| `charging_symbol` | `' '` | 當電池正在充電時顯示的符號。 | | `charging_symbol` | `'󰂄 '` | 當電池正在充電時顯示的符號。 |
| `discharging_symbol` | `' '` | 當電池正在放電時顯示的符號。 | | `discharging_symbol` | `'󰂃 '` | 當電池正在放電時顯示的符號。 |
| `unknown_symbol` | `' '` | 當電池狀態不明時顯示的符號。 | | `unknown_symbol` | `'󰁽 '` | 當電池狀態不明時顯示的符號。 |
| `empty_symbol` | `' '` | 當電池沒電時顯示的符號。 | | `empty_symbol` | `'󰂎 '` | 當電池沒電時顯示的符號。 |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. | | `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [連結](#battery-display) | 顯示的門檻與模組的風格。 | | `display` | [連結](#battery-display) | 顯示的門檻與模組的風格。 |
| `disabled` | `false` | 停用 `battery` 模組。 | | `disabled` | `false` | 停用 `battery` 模組。 |
@ -1517,6 +1528,8 @@ truncation_symbol = ''
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.
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
@ -1525,6 +1538,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | 這個模組的風格。 | | `style` | `'bold blue'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
@ -1724,6 +1738,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
| `only_nonzero_diffs` | `true` | Render status only for changed items. | | `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. | | `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Variables ### Variables
@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` | | `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` | | `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | 這個模組的風格。 | | `style` | `'bold red'` | 這個模組的風格。 |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | 停用 `git_status` 模組。 | | `disabled` | `false` | 停用 `git_status` 模組。 |
@ -1792,6 +1808,7 @@ The following variables can be used in `format`:
| `staged` | Displays `staged` when a new file has been added to the staging area. | | `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` | | style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1864,24 +1881,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
### 選項 ### 選項
| 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 Go. | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. | | `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. | | `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | 這個模組的風格。 | | `style` | `'bold cyan'` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `golang` 模組。 | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | 停用 `golang` 模組。 |
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | --------- | ------------------------------------ | | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` | | version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` | | mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) ' format = 'via [🏎💨 $version](bold cyan) '
``` ```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell ## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@ -2706,11 +2734,12 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | ---------- | ------------------------------------ | | --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` | | version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` | | engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| style\* | | Mirrors the value of option `style` | | 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 *: This variable can only be used as a part of a style string
@ -3565,7 +3594,7 @@ The `shell` module shows an indicator for currently used shell.
# ~/.config/starship.toml # ~/.config/starship.toml
[shell] [shell]
fish_indicator = '' fish_indicator = '󰈺 '
powershell_indicator = '_' powershell_indicator = '_'
unknown_indicator = 'mystery shell' unknown_indicator = 'mystery shell'
style = 'cyan bold' style = 'cyan bold'
@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### 選項
| Option | 預設 | 說明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | Disables this module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| 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
### 範例
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
@ -4162,7 +4229,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `說明` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

10
docs/zh-TW/guide/README.md
View File

@ -112,6 +112,14 @@
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" 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> /></a>
&nbsp; &nbsp;
<a <a
@ -263,7 +271,7 @@ Install Starship using any of the following package managers:
</details> </details>
### 第二步 為您的 shell 安裝 Starship ### 第二步 Set up your shell to use Starship
設定您的 shell 以啟用 Starship。 請從下列選單選取您的 shell： 設定您的 shell 以啟用 Starship。 請從下列選單選取您的 shell：