andrei/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2026-06-23 02:05:51 +07:00
Code Issues Packages Projects Releases 10 Wiki 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
78 changed files with 2702 additions and 1202 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/pl-PL/config/README.md
+121 -54
View File
@@ -298,6 +298,7 @@ $red\
$ruby\
$rust\
$scala\
$solidity\
$swift\
$terraform\
$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 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.
@@ -426,12 +427,13 @@ The `azure` module shows the current Azure Subscription. This is based on showin
### Options
| Zmienne | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'ﴃ '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
| Zmienne | Default | Description |
| ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Examples
@@ -443,7 +445,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
[azure]
disabled = false
format = 'on [$symbol($subscription)]($style) '
symbol = 'ﴃ '
symbol = '󰠅 '
style = 'blue bold'
```
@@ -455,10 +457,19 @@ style = 'blue bold'
[azure]
disabled = false
format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
symbol = "󰠅 "
style = "blue bold"
```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
@@ -467,11 +478,11 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
| `full_symbol` | `' '` | The symbol shown when the battery is full. |
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
| `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |
| `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |
| `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -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.
::: tip
::: porada
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 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.
:::
::: 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.
@@ -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.
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
| 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. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | The style for the 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.
::: tip
::: porada
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. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
| `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### 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.
::: 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.
@@ -1772,6 +1787,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. |
| `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. |
| `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. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` |
*: 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
| Option | Default | Description |
| ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. |
| Option | Default | Description |
| ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | The style for the module. |
| `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables
| Zmienne | Example | Description |
| --------- | --------- | ------------------------------------ |
| version | `v1.12.1` | The version of `go` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
| Zmienne | Example | Description |
| ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` |
| mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| 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
@@ -1894,6 +1913,15 @@ The `golang` module shows the currently installed version of [Go](https://golang
format = 'via [🏎💨 $version](bold cyan) '
```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
@@ -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`.
::: tip
::: porada
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.
::: tip
::: porada
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
| Zmienne | Example | Description |
| --------- | ---------- | ------------------------------------ |
| version | `v13.12.0` | The version of `node` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
| Zmienne | Example | Description |
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` |
| engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| 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
@@ -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.
@@ -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.
::: 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).
@@ -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 |
| `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.
@@ -3525,7 +3554,7 @@ symbol = '🌟 '
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.
@@ -3565,7 +3594,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml
[shell]
fish_indicator = ''
fish_indicator = '󰈺 '
powershell_indicator = '_'
unknown_indicator = 'mystery shell'
style = 'cyan bold'
@@ -3640,6 +3669,44 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
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
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.
::: tip
::: porada
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.
::: tip
::: porada
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.
::: 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).
@@ -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.
::: tip
::: porada
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 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.
@@ -4128,19 +4195,19 @@ These modules will be shown if any of the following conditions are met:
- The `when` command returns 0
- 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 `.`.
:::
::: 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.
:::
::: 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!