mirror of
https://github.com/starship/starship.git
synced 2026-06-22 02:02:12 +07:00
docs(i18n): new Crowdin updates (#4719)
This commit is contained in:
@@ -149,14 +149,14 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب
|
||||
|
||||
::: warning
|
||||
|
||||
This will change in the future. Only Nushell v0.61+ is supported.
|
||||
This will change in the future. Only Nushell v0.73+ is supported.
|
||||
|
||||
:::
|
||||
|
||||
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
||||
```sh
|
||||
mkdir ~/.cache/starship
|
||||
starship init nu | save ~/.cache/starship/init.nu
|
||||
starship init nu | save -f ~/.cache/starship/init.nu
|
||||
```
|
||||
|
||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
||||
|
||||
@@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a
|
||||
|
||||
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
|
||||
|
||||
Note: Nushell 0.71.0 or later is required
|
||||
|
||||
### نموونە
|
||||
|
||||
```toml
|
||||
@@ -231,7 +229,7 @@ Produces a prompt like the following:
|
||||
|
||||
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
|
||||
|
||||
Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`.
|
||||
Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`.
|
||||
|
||||
Note: `continuation_prompt` should be set to a literal string without any variables.
|
||||
|
||||
@@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# A continuation prompt that displays two filled in arrows
|
||||
continuation_prompt = "▶▶"
|
||||
continuation_prompt = '▶▶ '
|
||||
```
|
||||
|
||||
## Style Strings
|
||||
|
||||
+182
-42
@@ -252,12 +252,14 @@ $singularity\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$fossil_branch\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
$c\
|
||||
@@ -270,6 +272,7 @@ $dotnet\
|
||||
$elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
$haskell\
|
||||
@@ -278,6 +281,7 @@ $helm\
|
||||
$java\
|
||||
$julia\
|
||||
$kotlin\
|
||||
$gradle\
|
||||
$lua\
|
||||
$nim\
|
||||
$nodejs\
|
||||
@@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
|
||||
|
||||
::: tip
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
@@ -1320,13 +1330,14 @@ default = 'unknown user'
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
|
||||
| `symbol` | `''` | The symbol used before displaying the variable value. |
|
||||
| `گۆڕاو` | | The environment variable to be displayed. |
|
||||
| `default` | | The default value to be displayed when the selected variable is not defined. |
|
||||
| `format` | `'with [$env_value]($style) '` | The format for the module. |
|
||||
| `disabled` | `false` | Disables the `env_var` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
|
||||
| `symbol` | `""` | The symbol used before displaying the variable value. |
|
||||
| `گۆڕاو` | | The environment variable to be displayed. |
|
||||
| `default` | | The default value to be displayed when the selected variable is not defined. |
|
||||
| `format` | `"with [$env_value]($style) "` | The format for the module. |
|
||||
| `description` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
|
||||
| `disabled` | `false` | Disables the `env_var` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
format = 'via [e $version](bold red) '
|
||||
```
|
||||
|
||||
## Fennel
|
||||
|
||||
The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a file with the `.fnl` extension
|
||||
|
||||
### 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` | `'🧅 '` | The symbol used before displaying the version of fennel. |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `disabled` | `false` | Disables the `fennel` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v1.2.1` | The version of `fennel` |
|
||||
| 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
|
||||
|
||||
[fennel]
|
||||
symbol = '⫰ '
|
||||
```
|
||||
|
||||
## Fill
|
||||
|
||||
The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.
|
||||
@@ -1428,6 +1477,42 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. |
|
||||
| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `disabled` | `true` | Disables the `fossil_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| branch | `trunk` | The active Fossil branch |
|
||||
| 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
|
||||
|
||||
[fossil_branch]
|
||||
symbol = '🦎 '
|
||||
truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Google Cloud (`gcloud`)
|
||||
|
||||
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
|
||||
@@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | --------- | ----------------------------------- |
|
||||
| hash | `b703eb3` | The current git commit hash |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | --------- | -------------------------------------------- |
|
||||
| hash | `b703eb3` | The current git commit hash |
|
||||
| tag | `v1.0.0` | The tag name if showing tag info is enabled. |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
@@ -1840,6 +1926,41 @@ disabled = true
|
||||
format = 'via [🐂](yellow bold) '
|
||||
```
|
||||
|
||||
## Gradle
|
||||
|
||||
The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory.
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory.
|
||||
- The current directory contains a file ending with `.gradle` or `.gradle.kts`.
|
||||
|
||||
The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.
|
||||
|
||||
### 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 Gradle. |
|
||||
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold bright-cyan"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `gradle` module. |
|
||||
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| ------- | -------- | ------------------------------------ |
|
||||
| version | `v7.5.1` | The version of `gradle` |
|
||||
| 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
|
||||
|
||||
## Haskell
|
||||
|
||||
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
|
||||
@@ -2038,13 +2159,13 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: warning
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
@@ -2440,26 +2561,27 @@ style = 'bold dimmed green'
|
||||
|
||||
## Mercurial Branch
|
||||
|
||||
The `hg_branch` module shows the active branch of the repo in your current directory.
|
||||
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes |
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| branch | `master` | The active mercurial branch |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| branch | `master` | The active mercurial branch |
|
||||
| topic | `feature` | The active mercurial topic |
|
||||
| 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
|
||||
|
||||
@@ -2522,23 +2644,25 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------ | ---------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
|
||||
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
|
||||
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
|
||||
| `disabled` | `false` | Disables the `nix_shell` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
|
||||
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
|
||||
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
|
||||
| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. |
|
||||
| `disabled` | `false` | Disables the `nix_shell` module. |
|
||||
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| state | `بێخەوش` | The state of the nix-shell |
|
||||
| name | `lorri` | The name of the nix-shell |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| state | `pure` | The state of the nix-shell |
|
||||
| name | `lorri` | The name of the nix-shell |
|
||||
| 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
|
||||
|
||||
@@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
|
||||
disabled = true
|
||||
impure_msg = '[impure shell](bold red)'
|
||||
pure_msg = '[pure shell](bold green)'
|
||||
unknown_msg = '[unknown shell](bold yellow)'
|
||||
format = 'via [☃️ $state( \($name\))](bold blue) '
|
||||
```
|
||||
|
||||
@@ -2720,7 +2845,7 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
@@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
format = 'via [🔹 $version](147 bold) '
|
||||
```
|
||||
|
||||
## Pijul Channel
|
||||
|
||||
The `pijul_channel` module shows the active channel of the repo in your current directory.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
|
||||
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `format` | `'on [$symbol$channel]($style) '` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes |
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `pijul` module. |
|
||||
|
||||
## Pulumi
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/workflow/status/starship/starship/Main workflow/master?label=workflow&style=flat-square"
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
alt="دۆخی ڕێڕەوی کارەکان لە GitHub Actions"
|
||||
/></a>
|
||||
<a href="https://crates.io/crates/starship"
|
||||
@@ -327,7 +327,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
|
||||
|
||||
```sh
|
||||
mkdir ~/.cache/starship
|
||||
starship init nu | save ~/.cache/starship/init.nu
|
||||
starship init nu | save -f ~/.cache/starship/init.nu
|
||||
```
|
||||
|
||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
||||
@@ -336,7 +336,7 @@ And add the following to the end of your Nushell configuration (find it by runni
|
||||
source ~/.cache/starship/init.nu
|
||||
```
|
||||
|
||||
Note: Only Nushell v0.61+ is supported
|
||||
Note: Only Nushell v0.73+ is supported
|
||||
|
||||
</details>
|
||||
|
||||
@@ -419,6 +419,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
|
||||
**Supporter Tier**
|
||||
|
||||
- [Dimension](https://dimension.dev/)
|
||||
- [Appwrite](https://appwrite.io/)
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
|
||||
@@ -15,7 +15,7 @@ There are so many platforms out there that they didn't fit into the main README.
|
||||
|
||||
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
|
||||
|
||||
### Installation
|
||||
### دامەزراندن
|
||||
|
||||
```powershell
|
||||
choco install starship
|
||||
@@ -29,7 +29,7 @@ choco install starship
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### Installation
|
||||
### دامەزراندن
|
||||
|
||||
```sh
|
||||
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin
|
||||
@@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term
|
||||
|
||||
## [Funtoo Linux](https://www.funtoo.org/Welcome)
|
||||
|
||||
### Installation
|
||||
### دامەزراندن
|
||||
|
||||
On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage:
|
||||
|
||||
|
||||
@@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user