1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 03:27:30 +00:00

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

This commit is contained in:
Matan Kushner 2023-02-01 01:14:38 +09:00 committed by GitHub
parent 30084e113a
commit 2ef9360797
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
111 changed files with 6665 additions and 3804 deletions

View File

@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -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. `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 ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ----------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `الافتراضي` | | The default value to be displayed when the selected variable is not defined. | | `الافتراضي` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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 | الافتراضي | الوصف |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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
| Variable | مثال | الوصف |
| --------- | -------- | ------------------------------------ |
| 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 ## 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. 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 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 | الافتراضي | الوصف |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `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
| Variable | مثال | الوصف |
| --------- | ------- | ------------------------------------ |
| 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`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | مثال | الوصف | | Variable | مثال | الوصف |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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 | الافتراضي | الوصف |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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
| Variable | مثال | الوصف |
| -------- | -------- | ------------------------------------ |
| 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. 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. - 1 job -> `symbol` is shown.
- 2 jobs or more -> `symbol` + `number` are shown. - 2 jobs or more -> `symbol` + `number` are shown.
::: warning ::: تحذير
This module is not supported on tcsh and nu. 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. 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,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | مثال | الوصف | | Variable | مثال | الوصف |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' 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. 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. 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) ' format = 'via [🔹 $version](147 bold) '
``` ```
## Pijul Channel
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Options
| Option | الافتراضي | الوصف |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `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 ## Pulumi
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.
@ -4016,7 +4156,7 @@ 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. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `الوصف` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `description` | `'<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. |

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="GitHub Actions workflow status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
@ -340,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### Installation ### التثبيت
```powershell ```powershell
choco install starship choco install starship
@ -29,7 +29,7 @@ choco install starship
pkg install getconf pkg install getconf
``` ```
### Installation ### التثبيت
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin 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) ## [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: 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:

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -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. `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 ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `گۆڕاو` | | The environment variable to be displayed. | | `گۆڕاو` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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 ## 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. 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 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`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. 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. - 1 job -> `symbol` is shown.
- 2 jobs or more -> `symbol` + `number` are shown. - 2 jobs or more -> `symbol` + `number` are shown.
::: warning ::: ئاگادارکردنەوە
This module is not supported on tcsh and nu. 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. 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,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,19 +2645,21 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
| --------- | -------- | ------------------------------------ | | --------- | ------- | ------------------------------------ |
| state | `بێخەوش` | The state of the nix-shell | | state | `pure` | The state of the nix-shell |
| name | `lorri` | The name of the nix-shell | | name | `lorri` | The name of the nix-shell |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' 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. 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. 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) ' 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 ## Pulumi
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.

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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" alt="دۆخی ڕێڕەوی کارەکان لە GitHub Actions"
/></a> /></a>
<a href="https://crates.io/crates/starship" <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 ```sh
mkdir ~/.cache/starship 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`): 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 source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -419,6 +419,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### Installation ### دامەزراندن
```powershell ```powershell
choco install starship choco install starship
@ -29,7 +29,7 @@ choco install starship
pkg install getconf pkg install getconf
``` ```
### Installation ### دامەزراندن
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin 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) ## [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: 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:

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
::: warning ::: warning
Das wird sich in Zukunft ändern. Nur Nushell v0.61+ wird unterstützt. Das wird sich in Zukunft ändern. Nur Nushell v0.73+ wird unterstützt.
::: :::
Füge folgendes an das Ende deiner Nushell env Datei hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.env-path`): Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.config-path`): Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.config-path`):

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Beispiel ### Beispiel
```toml ```toml
@ -231,7 +229,7 @@ Produces a prompt like the following:
Einige Shells unterstützen einen speziellen Fortsetzungsprompt zusätzlich zum normalen Prompt. Dieser Prompt wird anstelle des normalen Prompts ausgegeben, wenn der Benutzer ein unvollständiges Kommando eingegeben hat (etwa wie eine einzelne linke Klammer oder ein einzelnes Anführungszeichen). Einige Shells unterstützen einen speziellen Fortsetzungsprompt zusätzlich zum normalen Prompt. Dieser Prompt wird anstelle des normalen Prompts ausgegeben, wenn der Benutzer ein unvollständiges Kommando eingegeben hat (etwa wie eine einzelne linke Klammer oder ein einzelnes Anführungszeichen).
Starship kann das Aussehen des Fortsetzungs-Prompts mit der `continuation_prompt` Option einstellen. The default prompt is `"[∙](bright-black) "`. Starship kann das Aussehen des Fortsetzungs-Prompts mit der `continuation_prompt` Option einstellen. The default prompt is `'[∙](bright-black) '`.
Hinweis: Die `continuation_prompt` Anweisung sollte auf einen literalen String ohne Variablen gesetzt werden. Hinweis: Die `continuation_prompt` Anweisung sollte auf einen literalen String ohne Variablen gesetzt werden.
@ -247,7 +245,7 @@ Hinweis: Fortsetzungs-Prompts sind nur für folgende Shells verfügbar:
# ~/.config/starship.toml # ~/.config/starship.toml
# Ein Fortsetzungs-Prompt der 2 ausgefüllte Pfeile darstellt # Ein Fortsetzungs-Prompt der 2 ausgefüllte Pfeile darstellt
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style-Strings ## Style-Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------------------- |
| `symbol` | `''` | Das Symbol, das vor der Anzeige der Variable verwendet wird. | | `symbol` | `""` | Das Symbol, das vor der Anzeige der Variable verwendet wird. |
| `variable` | | Die anzuzeigende Umgebungsvariable. | | `variable` | | Die anzuzeigende Umgebungsvariable. |
| `default` | | Der Standardwert, der angezeigt wird, wenn die ausgewählte Variable nicht definiert ist. | | `default` | | Der Standardwert, der angezeigt wird, wenn die ausgewählte Variable nicht definiert ist. |
| `format` | `'with [$env_value]($style) '` | Das Format für das Modul. | | `format` | `"with [$env_value]($style) "` | Das Format für das Modul. |
| `description` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
| `disabled` | `false` | Deaktiviert das `env_var`-Modul. | | `disabled` | `false` | Deaktiviert das `env_var`-Modul. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
### Optionen
| Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Stil für dieses Modul. |
| `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
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------- |
| version | `v1.2.1` | The version of `fennel` |
| 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
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 AA -------------------------------------------- BB -------------------------------------------- CC
``` ```
## Fossil Branch
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
### Optionen
| Option | Standartwert | Beschreibung |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol$branch]($style) '` | Das Format für das Modul. 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'` | Stil für dieses Modul. |
| `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
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------- |
| branch | `trunk` | The active Fossil branch |
| 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
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1501,9 +1586,9 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
very-long-project-name = 'vlpn' very-long-project-name = 'vlpn'
``` ```
## Git-Branch ## Git Branch
Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an. The `git_branch` module shows the active branch of the repo in your current directory.
### Optionen ### Optionen
@ -1517,7 +1602,7 @@ Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuelle
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | --------- | ------------------------------------ | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | hash | `b703eb3` | The current git commit hash |
| tag | `v1.0.0` | The tag name if showing tag info is enabled. |
| 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
@ -1579,7 +1665,7 @@ commit_hash_length = 4
tag_symbol = '🔖 ' tag_symbol = '🔖 '
``` ```
## Git-Zustand ## Git State
The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
@ -1596,7 +1682,7 @@ The `git_state` module will show in directories which are part of a git reposito
| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `'bold yellow'` | Stil für dieses Modul. | | `style` | `'bold yellow'` | Stil für dieses Modul. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Das Format für das Modul. | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Das Format für das Modul. |
| `disabled` | `false` | Deaktiviert das `git_state`-Modul. | | `disabled` | `false` | Disables the `git_state` module. |
### Variables ### Variables
@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
::: tip ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -1688,7 +1774,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `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` | Disables the `git_status` module. |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
### Variables ### Variables
@ -1787,7 +1873,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
| `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. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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.
### Optionen
| Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | 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"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
### Variables
| Variable | Beispiel | Beschreibung |
| -------- | -------- | ------------------------------------- |
| version | `v7.5.1` | The version of `gradle` |
| 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
## Haskell ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -1954,18 +2075,18 @@ format = 'via [⎈ $version](bold white) '
## Hostname ## Hostname
Das `hostname`-Modul zeigt den Hostnamen des Systems an. The `hostname` module shows the system hostname.
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | | `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | Das Format für das Modul. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | Das Format für das Modul. |
| `style` | `'bold dimmed green'` | Stil für dieses Modul. | | `style` | `'bold dimmed green'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `hostname`-Modul. | | `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
@ -2007,7 +2128,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `'☕ '` | A format string representing the symbol of Java | | `symbol` | `'☕ '` | A format string representing the symbol of Java |
| `style` | `'red dimmed'` | Stil für dieses Modul. | | `style` | `'red dimmed'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `Java`-Modul. | | `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -2053,14 +2174,14 @@ The `threshold` option is deprecated, but if you want to use it, the module will
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------------ | ----------------------------- | -------------------------------------------------------------------------------- | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ |
| `threshold`* | `1` | Zeigt die Anzahl der Jobs wenn der angegebene Schwellenwert überschritten wurde. | | `threshold`* | `1` | Show number of jobs if exceeded. |
| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |
| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |
| `format` | `'[$symbol$number]($style) '` | Das Format für das Modul. | | `format` | `'[$symbol$number]($style) '` | Das Format für das Modul. |
| `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. |
| `style` | `'bold blue'` | Stil für dieses Modul. | | `style` | `'bold blue'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `jobs`-Modul. | | `disabled` | `false` | Disables the `jobs` module. |
*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.
@ -2178,7 +2299,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
::: tip ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions.
@ -2196,7 +2317,7 @@ When the module is enabled it will always be active, unless any of `detect_exten
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `true` | Deaktiviert das `kubernetes`-Modul. | | `disabled` | `true` | Disables the `kubernetes` module. |
### Variables ### Variables
@ -2259,15 +2380,15 @@ Long and automatically generated cluster names can be identified and shortened u
'gke_.*_(?P<var_cluster>[\\w-]+)' = 'gke-$var_cluster' 'gke_.*_(?P<var_cluster>[\\w-]+)' = 'gke-$var_cluster'
``` ```
## Zeilenumbruch ## Line Break
Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. The `line_break` module separates the prompt into two lines.
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ---------- | ------------ | ---------------------------------------------------------------------- | | ---------- | ------------ | ------------------------------------------------------------------ |
| `disabled` | `false` | Deaktiviert das `line_break`-Modul, wodurch der Prompt einzeilig wird. | | `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
### Beispiel ### Beispiel
@ -2352,27 +2473,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
format = 'via [🌕 $version](bold blue) ' format = 'via [🌕 $version](bold blue) '
``` ```
## Speicherauslastung ## Memory Usage
Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an. The `memory_usage` module shows current system memory and swap usage.
Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist. By default the swap usage is displayed if the total system swap is non-zero.
::: tip ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ----------- | ----------------------------------------------- | --------------------------------------------------------------------- | | ----------- | ----------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Speicherauslastung ausblenden, wenn sie unter diesem Prozentsatz ist. | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Das Format für das Modul. | | `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Das Format für das Modul. |
| `symbol` | `'🐏'` | Symbol das vor der Speicherauslastung angezeigt wird. | | `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |
| `style` | `'bold dimmed white'` | Stil für dieses Modul. | | `style` | `'bold dimmed white'` | Stil für dieses Modul. |
| `disabled` | `true` | Deaktiviert das `memory_usage`-Modul. | | `disabled` | `true` | Disables the `memory_usage` module. |
### Variables ### Variables
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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.
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `'bold purple'` | Stil für dieses Modul. | | `style` | `'bold purple'` | Stil für dieses Modul. |
| `format` | `'on [$symbol$branch]($style) '` | Das Format für das Modul. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | Das Format für das Modul. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------- | | --------- | --------- | ------------------------------------- |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Spiegelt den Wert der Option `symbol` | | symbol | | Spiegelt den Wert der Option `symbol` |
| style\* | | Spiegelt den Wert der Option `style` | | style\* | | Spiegelt den Wert der Option `style` |
@ -2487,7 +2609,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul | | `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` | `'👑 '` | The symbol used before displaying the version of Nim. | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. |
@ -2516,20 +2638,22 @@ style = 'yellow'
symbol = '🎣 ' symbol = '🎣 '
``` ```
## Nix-Shell ## Nix-shell
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet. The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment.
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | Das Format für das Modul. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | Das Format für das Modul. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | Stil für dieses Modul. | | `style` | `'bold blue'` | Stil für dieses Modul. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. | | `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 ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2576,7 +2701,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. | | `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | Stil für dieses Modul. | | `style` | `'bold green'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `nodejs`-Modul. | | `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | | `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. |
### Variables ### Variables
@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known
::: tip ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -2813,9 +2938,9 @@ Windows = " "
Arch = "Arch is the best! " Arch = "Arch is the best! "
``` ```
## Paketversion ## Package Version
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory - [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2842,11 +2967,11 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | Das Format für das Modul. | | `format` | `'is [$symbol$version]($style) '` | Das Format für das Modul. |
| `symbol` | `'📦 '` | Symbol das vor der Paketversion angezeigt wird. | | `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
| `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` |
| `style` | `'bold 208'` | Stil für dieses Modul. | | `style` | `'bold 208'` | Stil für dieses Modul. |
| `display_private` | `false` | Enable displaying version for packages marked as private. | | `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Deaktiviert das `package`-Modul. | | `disabled` | `false` | Disables the `package` module. |
### Variables ### Variables
@ -2911,7 +3036,7 @@ format = 'via [🦪 $version]($style) '
The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - Das aktuelle Verzeichnis enthält eine `composer.json`-Datei
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` extension - The current directory contains a `.php` extension
@ -2921,12 +3046,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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` | `'🐘 '` | Symbol das vor der PHP-Version angezeigt wird. | | `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. |
| `detect_extensions` | `['php']` | Which extensions should trigger this module. | | `detect_extensions` | `['php']` | Which extensions should trigger this module. |
| `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. | | `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'147 bold'` | Stil für dieses Modul. | | `style` | `'147 bold'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `php`-Modul. | | `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' format = 'via [🔹 $version](147 bold) '
``` ```
## Pijul Channel
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Optionen
| Option | Standartwert | Beschreibung |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
| `style` | `'bold purple'` | Stil für dieses Modul. |
| `format` | `'on [$symbol$channel]($style) '` | Das Format für das Modul. |
| `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 ## Pulumi
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.
@ -3070,13 +3210,13 @@ By default the module will be shown if any of the following conditions are met:
| `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 Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | Stil für dieses Modul. | | `style` | `'yellow bold'` | Stil für dieses Modul. |
| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | Which extensions should trigger this module | | `detect_extensions` | `['py']` | Which extensions should trigger this module |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module |
| `disabled` | `false` | Deaktiviert das `python`-Modul. | | `disabled` | `false` | Disables the `python` module. |
::: tip ::: tip
@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) '
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension - The current directory contains a file with `.red` or `.reds` extension
@ -3253,7 +3393,7 @@ symbol = '🔴 '
## Ruby ## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei - Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -3274,7 +3414,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. |
| `style` | `'bold red'` | Stil für dieses Modul. | | `style` | `'bold red'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -3297,7 +3437,7 @@ symbol = '🔺 '
## Rust ## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei - Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei
- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung - Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung
@ -3313,7 +3453,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. | | `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold red'` | Stil für dieses Modul. | | `style` | `'bold red'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `rust`-Modul. | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -3382,7 +3522,7 @@ The `shell` module shows an indicator for currently used shell.
::: tip ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -3410,7 +3550,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| Variable | Standartwert | Beschreibung | | Variable | Standartwert | Beschreibung |
| --------- | ------------ | ---------------------------------------------------------- | | --------- | ------------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Spiegelt den Wert der 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
@ -3534,7 +3674,7 @@ The `status` module displays the exit code of the previous command. If $success_
::: tip ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -3595,7 +3735,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module
::: tip ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -3640,7 +3780,7 @@ disabled = false
## Swift ## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
@ -3703,7 +3843,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | | `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
| `style` | `'bold 105'` | Stil für dieses Modul. | | `style` | `'bold 105'` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `terraform` Modul. | | `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -3736,26 +3876,26 @@ format = '[🏎💨 $version$workspace]($style) '
format = '[🏎💨 $workspace]($style) ' format = '[🏎💨 $workspace]($style) '
``` ```
## Zeit ## Uhrzeit
Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. 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 ::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | The format string for the module. | | `format` | `'at [$time]($style) '` | The format string for the module. |
| `use_12hr` | `false` | Aktiviert 12-Stunden-Format | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `'bold yellow'` | Stil für dieses Modul | | `style` | `'bold yellow'` | The style for the module time |
| `utc_time_offset` | `'local'` | Verwendetes Zeitzonen-Offset. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. | | `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Deaktiviert das `time`-Modul. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting.
@ -3764,7 +3904,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | ---------- | ------------------------------------ | | --------- | ---------- | ------------------------------------ |
| zeit | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| 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
@ -3784,7 +3924,7 @@ time_range = '10:00:00-14:00:00'
## Username ## Username
Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer - Der aktuelle Benutzer ist nicht der eingeloggte Benutzer
@ -3800,12 +3940,12 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ------------- | ----------------------- | ---------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `'bold red'` | The style used when the user is root/admin. | | `style_root` | `'bold red'` | The style used when the user is root/admin. |
| `style_user` | `'bold yellow'` | Stil wenn der Benutzer nicht unter root läuft. | | `style_user` | `'bold yellow'` | The style used for non-root users. |
| `format` | `'[$user]($style) in '` | Das Format für das Modul. | | `format` | `'[$user]($style) in '` | Das Format für das Modul. |
| `show_always` | `false` | Immer das `username` Modul anzeigen. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Deavktiviert das `username` Modul. | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) '
## Zig ## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -4016,7 +4156,7 @@ 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. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `beschreibung` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `description` | `'<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. |

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="Workflow-Status der GitHub Actions" alt="Workflow-Status der GitHub Actions"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.config-path`): Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.config-path`):
@ -340,7 +340,7 @@ Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente
::: warning ::: warning
Esto cambiará en el futuro. Sólo se admite Nushell v0.61+. Esto cambiará en el futuro. Sólo se admite Nushell v0.73+.
::: :::
Añade lo siguiente al final de tu archivo Nushell env (encuéntralo ejecutando `$nu.env-path` en Nushell): Añade lo siguiente al final de tu archivo Nushell env (encuéntralo ejecutando `$nu.env-path` en Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`): Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`):

View File

@ -1,18 +1,18 @@
# Configuración Avanzada # Configuración Avanzada
Mientras que Starship es un prompt versátil, a veces necesitas más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship. A pesar de que Starship es una prompt versátil, a veces necesitas hacer más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship.
::: warning ::: warning
Las configuraciones de esta sección están sujetos a cambios en futuras versiones de Starship. Las configuraciones de esta sección están sujetas a cambios en futuras versiones de Starship.
::: :::
## TransientPrompt en PowerShell ## Prompt Transitoria en PowerShell
Es posible reemplazar la entrada impresa anteriormente con una cadena personalizada. Esto es útil en los casos que toda la información de la entrada no es siempre necesaria. Para habilitar esto, ejecuta `Enable-TransientPrompt` en la línea de comandos. Para hacerlo permanente, haz esta declaración en tu `$PROFILE`. La transitoriedad puede ser desactivada al momento con `Disable-TransientPrompt`. Con una cadena personalizada, es posible reemplazar la prompt anteriormente impresa. Esto es útil en los casos en que toda la información de la prompt no es siempre necesaria. Para habilitar esto, ejecuta `Enable-TransientPrompt` en la línea de comandos. Para hacerlo permanente, pon esta misma sentencia en tu `$PROFILE`. La transitoriedad puede ser desactivada al momento con `Disable-TransientPrompt`.
Por defecto, el lado izquierdo de la entrada es reemplazado por `>`. Para personalizar esto, defina una nueva función llamada `Invoke-Starship-TransientFunction`. Por ejemplo, para mostrar el módulo `character` de Starship aquí, harías Por defecto, el lado izquierdo de la prompt es reemplazado por `>`. Para personalizar esto, defina una nueva función llamada `Invoke-Starship-TransientFunction`. Por ejemplo, para mostrar el módulo `character` de Starship aquí, harías
```powershell ```powershell
function Invoke-Starship-TransientFunction { function Invoke-Starship-TransientFunction {
@ -207,8 +207,6 @@ Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. P
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Ejemplo ### Ejemplo
```toml ```toml
@ -231,7 +229,7 @@ Produce un prompt como el siguiente:
Algunos intérpretes de comandos admiten un prompt de continuacion junto con el prompt normal. Este prompt es renderizado en lugar del prompt normal cuando el usuario ha introducido una orden incompleta (como solamente un paréntesis izquierdo o comilla). Algunos intérpretes de comandos admiten un prompt de continuacion junto con el prompt normal. Este prompt es renderizado en lugar del prompt normal cuando el usuario ha introducido una orden incompleta (como solamente un paréntesis izquierdo o comilla).
Starship puede establecer el prompt de continuación usando la opción `continuation_prompt`. El prompt por defecto es `"[∙](bright-black) "`. Starship puede establecer el prompt de continuación usando la opción `continuation_prompt`. El indicador por defecto es `'[∙](bright-black) '`.
Nota: `continuation_prompt` debe establecerse en una cadena literal sin ninguna variable. Nota: `continuation_prompt` debe establecerse en una cadena literal sin ninguna variable.
@ -247,7 +245,7 @@ Nota: Los prompts de continuación solo están disponibles en los siguientes int
# ~/.config/starship.toml # ~/.config/starship.toml
# Un prompt de continuación que muestra dos flechas rellenas # Un prompt de continuación que muestra dos flechas rellenas
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Cadenas de Estilo ## Cadenas de Estilo
@ -279,7 +277,7 @@ Un especificador de color puede ser uno de los siguientes:
Si se especifican varios colores para el primer plano/fondo, el último en la cadena tendrá prioridad. Si se especifican varios colores para el primer plano/fondo, el último en la cadena tendrá prioridad.
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist: No todas las cadenas de estilo se mostrarán correctamente en cada terminal. En particular, existen las siguientes rarezas conocidas:
- Many terminals disable support for `blink` by default - Many terminals disable support for `blink` by default
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564). - `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).

File diff suppressed because it is too large Load Diff

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="Estado del flujo de trabajo de GitHub Actions" alt="Estado del flujo de trabajo de GitHub Actions"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Añade lo siguiente al final de tu archivo Nushell env (encuéntralo ejecutando
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`): Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`):
@ -340,7 +340,7 @@ Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Nota: Sólo se admite Nushell v0.61+ Nota: Sólo se admite Nushell v0.73+
</details> </details>
@ -423,6 +423,7 @@ Apoya este proyecto [convirtiéndote en patrocinador](https://github.com/sponsor
**Patrocinadores** **Patrocinadores**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -14,7 +14,11 @@ Este preajuste cambia los símbolos de cada módulo para usar símbolos Nerd Fon
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. 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) [Click to view No Nerd Font preset](./no-nerd-font)
@ -52,7 +56,7 @@ Esta preajuste emula la apariencia y el comportamiento de [Pure](https://github.
Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). También muestra cómo funciona la sustitución de rutas en Starship. Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). También muestra cómo funciona la sustitución de rutas en Starship.
[![Captura de pantalla del preajuste Pastel Powerline](/presets/img/pastel-powerline.png "Haga clic para ver el preajuste del Prompt de Pure")](./pastel-powerline) [![Captura de pantalla del preajuste de Pastel Powerline](/presets/img/pastel-powerline.png "Haga clic para ver el preajuste del Prompt de Pure")](./pastel-powerline)
## [Tokyo Night](./tokyo-night.md) ## [Tokyo Night](./tokyo-night.md)

View File

@ -149,14 +149,14 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers
::: warning ::: warning
Ceci va changer dans le futur. Seul Nushell v0.61+ est supporté. Ceci va changer dans le futur. Seul Nushell v0.73+ est supporté.
::: :::
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 ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`): Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`):

View File

@ -207,8 +207,6 @@ Note: linvite à droite est une seule ligne, sur la même ligne que lentr
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Exemple ### Exemple
```toml ```toml
@ -231,7 +229,7 @@ Génère linvite suivante:
Certains shells gèrent une invite de continuation en plus de linvite normale. Cette invite est affichée à la place de linvite normale quand lutilisateur a entré une expression incomplète (par exemple, une parenthèse gauche ou une apostrophe seule). Certains shells gèrent une invite de continuation en plus de linvite normale. Cette invite est affichée à la place de linvite normale quand lutilisateur a entré une expression incomplète (par exemple, une parenthèse gauche ou une apostrophe seule).
Starship peut définir linvite de continuation en utilisant loption `continuation_prompt`. Linvite par défaut est `"[∙](bright-black) "`. Starship peut définir linvite de continuation en utilisant loption `continuation_prompt`. The default prompt is `'[∙](bright-black) '`.
Note: la valeur de `continuation_prompt` doit être une chaine littérale, sans variable. Note: la valeur de `continuation_prompt` doit être une chaine littérale, sans variable.
@ -247,7 +245,7 @@ Note: les invites de confirmation sont uniquement disponibles pour les shells su
# ~/.config/starship.toml # ~/.config/starship.toml
# Un invite de continuation qui affiche deux flèches pleines # Un invite de continuation qui affiche deux flèches pleines
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Chaînes de style ## Chaînes de style

File diff suppressed because it is too large Load Diff

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="Statut du workflow actions GitHub" alt="Statut du workflow actions GitHub"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`): Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`):
@ -340,7 +340,7 @@ Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Seul Nushell v0.61+ est supporté Note: Seul Nushell v0.73+ est supporté
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -14,7 +14,11 @@ Ce préréglage change les symboles de chaque module pour utiliser les symboles
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. 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) [Click to view No Nerd Font preset](./no-nerd-font)
@ -28,7 +32,7 @@ Ce préréglage modifie le format de tous les modules intégrés pour afficher l
Ce préréglage change les symboles de chaque module en texte brut. Idéal si vous n'avez pas accès à Unicode. Ce préréglage change les symboles de chaque module en texte brut. Idéal si vous n'avez pas accès à Unicode.
[![Capture d'écran du préréglage Symboles en texte brut](/presets/img/plain-text-symbols.png "Cliquez pour voir le préréglage Texte uniquement")](./plain-text) [![Capture d'écran du préréglage Texte uniquement](/presets/img/plain-text-symbols.png "Cliquez pour voir le préréglage Texte uniquement")](./plain-text)
## [Pas de version des environnements](./no-runtimes.md) ## [Pas de version des environnements](./no-runtimes.md)

View File

@ -149,14 +149,14 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
::: warning ::: warning
Hal ini dapat berubah di kemudian hari. Hanya Nushell v0.61+ yang menerima dukungan. Hal ini dapat berubah di kemudian hari. Hanya Nushell v0.73+ yang menerima dukungan.
::: :::
Tambahkan baris berikut di akhir env file Nushell (dengan menjalankan `$nu.env-path` di Nushell): Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan dengan menjalankan `$nu.config-path`): Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan dengan menjalankan `$nu.config-path`):

View File

@ -207,8 +207,6 @@ Catatan: Right propmt merupakan sebuah baris yang mengikuti lokasi baris inputan
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Contoh ### Contoh
```toml ```toml
@ -231,7 +229,7 @@ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
Beberapa shells mendukung continuation prompt bersamaan dengan prompt biasa. Prompt tersebutlah yang akan dirender daripada prompt biasa ketika pengguna memasukkan perintah yang kurang lengkap (seperti tanda kurung atau tanda kutipan tunggal). Beberapa shells mendukung continuation prompt bersamaan dengan prompt biasa. Prompt tersebutlah yang akan dirender daripada prompt biasa ketika pengguna memasukkan perintah yang kurang lengkap (seperti tanda kurung atau tanda kutipan tunggal).
Starship dapat mengatur continuation prompt dengan opsi `continuation_prompt`. Prompt bawaannya adalah `"[∙](bright-black) "`. Starship dapat mengatur continuation prompt dengan opsi `continuation_prompt`. The default prompt is `'[∙](bright-black) '`.
Catatan: `continuation_prompt` harus diubah menjadi string literal tanpa variabel apapun. Catatan: `continuation_prompt` harus diubah menjadi string literal tanpa variabel apapun.
@ -247,7 +245,7 @@ Catatan: Continuation prompts hanya tersedia pada beberapa shells berikut:
# ~/.config/starship.toml # ~/.config/starship.toml
# Continuation prompt yang menampilkan dua panah solid # Continuation prompt yang menampilkan dua panah solid
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Penataan String ## Penataan String

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ Modul `env_var` menampilkan nilai terkini dari variabel environment yang dipilih
::: tip ::: 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 `.`. (lihat contoh) Jika opsi konfigurasi `variable` tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter `.`. Multiple environmental variables can be displayed by using a `.`. (lihat contoh) Jika opsi konfigurasi `variable` tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter `.`.
Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------- | ------------------------------ | ------------------------------------------------------------------------------------- | | ------------- | ------------------------------ | ------------------------------------------------------------------------------------- |
| `symbol` | `''` | Simbol yang digunakan sebelum menampilkan nilai dari variabel. | | `symbol` | `""` | Simbol yang digunakan sebelum menampilkan nilai dari variabel. |
| `variabel` | | Variabel environment yang akan ditampilkan. | | `variabel` | | Variabel environment yang akan ditampilkan. |
| `bawaan` | | Nilai bawaan yang akan ditampilkan ketika variabel yang terpilih tidak didefinisikan. | | `bawaan` | | Nilai bawaan yang akan ditampilkan ketika variabel yang terpilih tidak didefinisikan. |
| `format` | `'with [$env_value]($style) '` | Format dari modul. | | `format` | `"with [$env_value]($style) "` | Format dari modul. |
| `description` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
| `disabled` | `false` | Menonaktifkan modul `env_var`. | | `disabled` | `false` | Menonaktifkan modul `env_var`. |
### Variabel ### Variabel
@ -1388,7 +1399,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' format = 'via [e $version](bold red) '
``` ```
## Fennel
The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
- The current directory contains a file with the `.fnl` extension
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Gaya penataan untuk modul. |
| `detect_extensions` | `[fnl]` | 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. |
| `disabled` | `false` | Disables the `fennel` module. |
### Variabel
| Variabel | Contoh | Deskripsi |
| --------- | -------- | --------------------------------- |
| version | `v1.2.1` | The version of `fennel` |
| 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
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 AA -------------------------------------------- BB -------------------------------------------- CC
``` ```
## Fossil Branch
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `fromat` | `'on [$symbol$branch]($style) '` | Format dari modul. 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'` | Gaya penataan untuk modul. |
| `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. |
### Variabel
| Variabel | Contoh | Deskripsi |
| --------- | ------- | --------------------------------- |
| branch | `trunk` | The active Fossil branch |
| 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
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1436,7 +1521,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format dari modul. | | `fromat` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format dari modul. |
| `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. |
@ -1510,7 +1595,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Format dari modul. Use `'$branch'` to refer to the current branch name. | | `fromat` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Format dari modul. Use `'$branch'` to refer to the current branch name. |
| `symbol` | `' '` | A format string representing the symbol of git branch. | | `symbol` | `' '` | A format string representing the symbol of git branch. |
| `style` | `'bold purple'` | Gaya penataan untuk modul. | | `style` | `'bold purple'` | Gaya penataan untuk modul. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
@ -1552,7 +1637,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `'[\($hash$tag\)]($style) '` | Format dari modul. | | `fromat` | `'[\($hash$tag\)]($style) '` | Format dari modul. |
| `style` | `'bold green'` | Gaya penataan untuk modul. | | `style` | `'bold green'` | Gaya penataan untuk modul. |
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variabel ### Variabel
| Variabel | Contoh | Deskripsi | | Variabel | Contoh | Deskripsi |
| --------- | --------- | -------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | hash | `b703eb3` | The current git commit hash |
| tag | `v1.0.0` | The tag name if showing tag info is enabled. |
| 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
@ -1595,7 +1681,7 @@ The `git_state` module will show in directories which are part of a git reposito
| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |
| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | | `fromat` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. |
| `disabled` | `false` | Disables the `git_state` module. | | `disabled` | `false` | Disables the `git_state` module. |
### Variabel ### Variabel
@ -1607,7 +1693,7 @@ The `git_state` module will show in directories which are part of a git reposito
| progress_total | `2` | The total operation progress | | progress_total | `2` | The total operation progress |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -1636,7 +1722,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `added_style` | `'bold green'` | The style for the added count. | | `added_style` | `'bold green'` | The style for the added count. |
| `deleted_style` | `'bold red'` | The style for the deleted count. | | `deleted_style` | `'bold red'` | The style for the deleted count. |
| `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 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. |
### Variabel ### Variabel
@ -1648,7 +1734,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| added_style\* | | Mirrors the value of option `added_style` | | added_style\* | | Mirrors the value of option `added_style` |
| deleted_style\* | | Mirrors the value of option `deleted_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -1674,7 +1760,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `fromat` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `'='` | This branch has merge conflicts. | | `conflicted` | `'='` | This branch has merge conflicts. |
| `ahead` | `'⇡'` | The format of `ahead` | | `ahead` | `'⇡'` | The format of `ahead` |
| `behind` | `'⇣'` | The format of `behind` | | `behind` | `'⇣'` | The format of `behind` |
@ -1708,7 +1794,7 @@ The following variables can be used in `format`:
| `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. |
| style\* | Menyalin nilai dari opsi `style` | | style\* | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
The following variables can be used in `diverged`: The following variables can be used in `diverged`:
@ -1828,7 +1914,7 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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.
Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
- 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.
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. |
| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `["gradle"]` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `"bold bright-cyan"` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
### Variabel
| Variabel | Contoh | Deskripsi |
| -------- | -------- | --------------------------------- |
| version | `v7.5.1` | The version of `gradle` |
| symbol | | Menyalin nilai dari opsi `symbol` |
| style* | | Menyalin nilai dari opsi `style` |
*: This variable can only be used as a part of a style string
## Haskell ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -1853,7 +1974,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | -------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `symbol` | `'λ '` | A format string representing the symbol of Haskell | | `symbol` | `'λ '` | A format string representing the symbol of Haskell |
| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['stack.yaml', 'cabal.project']` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `['stack.yaml', 'cabal.project']` | filenames mana yang sebaiknya memicu modul ini. |
@ -1885,7 +2006,7 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. |
| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["hx", "hxml"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `["hx", "hxml"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | filenames mana yang sebaiknya memicu modul ini. |
@ -1924,7 +2045,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | filenames mana yang sebaiknya memicu modul ini. |
@ -1963,7 +2084,7 @@ The `hostname` module shows the system hostname.
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | | `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | Format dari modul. | | `fromat` | `'[$ssh_symbol$hostname]($style) in '` | Format dari modul. |
| `style` | `'bold dimmed green'` | Gaya penataan untuk modul. | | `style` | `'bold dimmed green'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `hostname` module. | | `disabled` | `false` | Disables the `hostname` module. |
@ -2000,7 +2121,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | Format dari modul. | | `fromat` | `'via [${symbol}(${version} )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | filenames mana yang sebaiknya memicu modul ini. |
@ -2017,7 +2138,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -2057,7 +2178,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
| `threshold`* | `1` | Show number of jobs if exceeded. | | `threshold`* | `1` | Show number of jobs if exceeded. |
| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |
| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |
| `format` | `'[$symbol$number]($style) '` | Format dari modul. | | `fromat` | `'[$symbol$number]($style) '` | Format dari modul. |
| `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. |
| `style` | `'bold blue'` | Gaya penataan untuk modul. | | `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `jobs` module. | | `disabled` | `false` | Disables the `jobs` module. |
@ -2097,7 +2218,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['jl']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['jl']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['Project.toml', 'Manifest.toml']` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `['Project.toml', 'Manifest.toml']` | filenames mana yang sebaiknya memicu modul ini. |
@ -2135,7 +2256,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['kt', 'kts']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['kt', 'kts']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
@ -2153,7 +2274,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -2189,7 +2310,7 @@ When the module is enabled it will always be active, unless any of `detect_exten
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. | | `fromat` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. |
| `style` | `'cyan bold'` | Gaya penataan untuk modul. | | `style` | `'cyan bold'` | Gaya penataan untuk modul. |
| `context_aliases` | `{}` | Table of context aliases to display. | | `context_aliases` | `{}` | Table of context aliases to display. |
| `user_aliases` | `{}` | Table of user aliases to display. | | `user_aliases` | `{}` | Table of user aliases to display. |
@ -2209,7 +2330,7 @@ When the module is enabled it will always be active, unless any of `detect_exten
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -2287,7 +2408,7 @@ The `localip` module shows the IPv4 address of the primary network interface.
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------- | ------------------------- | ------------------------------------------------------ | | ---------- | ------------------------- | ------------------------------------------------------ |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
| `format` | `'[$localipv4]($style) '` | Format dari modul. | | `fromat` | `'[$localipv4]($style) '` | Format dari modul. |
| `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. |
| `disabled` | `true` | Disables the `localip` module. | | `disabled` | `true` | Disables the `localip` module. |
@ -2323,7 +2444,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. | | `symbol` | `'🌙 '` | A format string representing the symbol of Lua. |
| `detect_extensions` | `['lua']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['lua']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -2341,7 +2462,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -2369,7 +2490,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ----------- | ----------------------------------------------- | -------------------------------------------------------- | | ----------- | ----------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Format dari modul. | | `fromat` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Format dari modul. |
| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | | `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |
| `style` | `'bold dimmed white'` | Gaya penataan untuk modul. | | `style` | `'bold dimmed white'` | Gaya penataan untuk modul. |
| `disabled` | `true` | Disables the `memory_usage` module. | | `disabled` | `true` | Disables the `memory_usage` module. |
@ -2411,7 +2532,7 @@ By default the Meson project name is displayed, if `$MESON_DEVENV` is set.
| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- | | ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- |
| `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. | | `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. |
| `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. | | `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. |
| `format` | `'via [$symbol$project]($style) '` | Format dari modul. | | `fromat` | `'via [$symbol$project]($style) '` | Format dari modul. |
| `symbol` | `'⬢ '` | The symbol used before displaying the project name. | | `symbol` | `'⬢ '` | The symbol used before displaying the project name. |
| `style` | `'blue bold'` | Gaya penataan untuk modul. | | `style` | `'blue bold'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `meson` module. | | `disabled` | `false` | Disables the `meson` module. |
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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.
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `'bold purple'` | Gaya penataan untuk modul. | | `style` | `'bold purple'` | Gaya penataan untuk modul. |
| `format` | `'on [$symbol$branch]($style) '` | Format dari modul. | | `fromat` | `'on [$symbol$branch(:$topic)]($style) '` | Format dari modul. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variabel ### Variabel
| Variabel | Contoh | Deskripsi | | Variabel | Contoh | Deskripsi |
| --------- | -------- | --------------------------------- | | --------- | --------- | --------------------------------- |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
@ -2487,7 +2609,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul | | `format` | `'via [$symbol($version )]($style)'` | The format for the module |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | Gaya penataan untuk modul. | | `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variabel ### Variabel
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2703,7 +2828,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -2856,7 +2981,7 @@ The `package` module is shown when the current directory is the repository for a
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -2911,7 +3036,7 @@ format = 'via [🦪 $version]($style) '
The `php` module shows the currently installed version of [PHP](https://www.php.net/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: The `php` module shows the currently installed version of [PHP](https://www.php.net/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
- The current directory contains a `composer.json` file - Direktori ini memiliki berkas `composer.json`
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` extension - The current directory contains a `.php` extension
@ -2919,7 +3044,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. |
| `detect_extensions` | `['php']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['php']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -2936,7 +3061,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' format = 'via [🔹 $version](147 bold) '
``` ```
## Pijul Channel
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
| `style` | `'bold purple'` | Gaya penataan untuk modul. |
| `fromat` | `'on [$symbol$channel]($style) '` | Format dari modul. |
| `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 ## Pulumi
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.
@ -2966,7 +3106,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | | ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. | | `fromat` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | A format string shown before the Pulumi stack. | | `symbol` | `' '` | A format string shown before the Pulumi stack. |
| `style` | `'bold 5'` | Gaya penataan untuk modul. | | `style` | `'bold 5'` | Gaya penataan untuk modul. |
@ -3016,7 +3156,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | | `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. |
| `detect_extensions` | `['purs']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['purs']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3033,7 +3173,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3066,7 +3206,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format dari modul. | | `fromat` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($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 Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | Gaya penataan untuk modul. | | `style` | `'yellow bold'` | Gaya penataan untuk modul. |
@ -3149,7 +3289,7 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'📐'` | A format string representing the symbol of R. | | `symbol` | `'📐'` | A format string representing the symbol of R. |
| `style` | `'blue bold'` | Gaya penataan untuk modul. | | `style` | `'blue bold'` | Gaya penataan untuk modul. |
@ -3186,7 +3326,7 @@ The `raku` module shows the currently installed version of [Raku](https://www.ra
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. | | `fromat` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku | | `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3223,7 +3363,7 @@ By default the `red` module shows the currently installed version of [Red](https
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🔺 '` | A format string representing the symbol of Red. | | `symbol` | `'🔺 '` | A format string representing the symbol of Red. |
| `detect_extensions` | `['red']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['red']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3240,7 +3380,7 @@ By default the `red` module shows the currently installed version of [Red](https
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3266,7 +3406,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. | | `symbol` | `'💎 '` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `['rb']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['rb']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3306,7 +3446,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦀 '` | A format string representing the symbol of Rust | | `symbol` | `'🦀 '` | A format string representing the symbol of Rust |
| `detect_extensions` | `['rs']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['rs']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3348,7 +3488,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | Format dari modul. | | `fromat` | `'via [${symbol}(${version} )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['sbt', 'scala']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['sbt', 'scala']` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | filenames mana yang sebaiknya memicu modul ini. |
@ -3365,7 +3505,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3401,7 +3541,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | | `cmd_indicator` | `'cmd'` | A format string used to represent cmd. |
| `nu_indicator` | `'nu'` | A format string used to represent nu. | | `nu_indicator` | `'nu'` | A format string used to represent nu. |
| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. | | `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. |
| `format` | `'[$indicator]($style) '` | Format dari modul. | | `fromat` | `'[$indicator]($style) '` | Format dari modul. |
| `style` | `'white bold'` | Gaya penataan untuk modul. | | `style` | `'white bold'` | Gaya penataan untuk modul. |
| `disabled` | `true` | Disables the `shell` module. | | `disabled` | `true` | Disables the `shell` module. |
@ -3410,7 +3550,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Variabel | Bawaan | Deskripsi | | Variabel | Bawaan | Deskripsi |
| --------- | ------ | ---------------------------------------------------------- | | --------- | ------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Menyalin nilai dari opsi `style`. | | style\* | | Mirrors the value of option `style`. |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
@ -3436,7 +3576,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ----------- | ---------------------------- | ------------------------------------------------------------- | | ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Display threshold. | | `threshold` | `2` | Display threshold. |
| `format` | `'[$symbol$shlvl]($style) '` | Format dari modul. | | `fromat` | `'[$symbol$shlvl]($style) '` | Format dari modul. |
| `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. | | `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. |
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. |
@ -3471,7 +3611,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------- | -------------------------------- | ------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | Format dari modul. | | `fromat` | `'[$symbol\[$env\]]($style) '` | Format dari modul. |
| `symbol` | `''` | A format string displayed before the image name. | | `symbol` | `''` | A format string displayed before the image name. |
| `style` | `'bold dimmed blue'` | Gaya penataan untuk modul. | | `style` | `'bold dimmed blue'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `singularity` module. | | `disabled` | `false` | Disables the `singularity` module. |
@ -3506,7 +3646,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat
| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` artinya tidak ada potongan. Lihat juga modul [`directory`](#directory). | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` artinya tidak ada potongan. Lihat juga modul [`directory`](#directory). |
| `symbol` | `'🅢 '` | Simbol yang digunakan sebelum nama environment. | | `symbol` | `'🅢 '` | Simbol yang digunakan sebelum nama environment. |
| `style` | `'bold blue'` | Gaya penataan untuk modul. | | `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `format` | `'via [$symbol$environment]($style) '` | Format dari modul. | | `fromat` | `'via [$symbol$environment]($style) '` | Format dari modul. |
| `disabled` | `false` | Disables the `spack` module. | | `disabled` | `false` | Disables the `spack` module. |
### Variabel ### Variabel
@ -3517,7 +3657,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3542,7 +3682,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'[$symbol$status]($style) '` | The format of the module | | `fromat` | `'[$symbol$status]($style) '` | The format of the module |
| `symbol` | `'❌'` | The symbol displayed on program error | | `symbol` | `'❌'` | The symbol displayed on program error |
| `success_symbol` | `''` | The symbol displayed on program success | | `success_symbol` | `''` | The symbol displayed on program success |
| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable | | `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
@ -3573,7 +3713,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3603,7 +3743,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| --------------- | ------------------------ | ------------------------------------------------------- | | --------------- | ------------------------ | ------------------------------------------------------- |
| `format` | `'[as $symbol]($style)'` | The format of the module | | `fromat` | `'[as $symbol]($style)'` | The format of the module |
| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached | | `symbol` | `'🧙 '` | The symbol displayed when credentials are cached |
| `style` | `'bold blue'` | Gaya penataan untuk modul. | | `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
@ -3649,7 +3789,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐦 '` | A format string representing the symbol of Swift | | `symbol` | `'🐦 '` | A format string representing the symbol of Swift |
| `detect_extensions` | `['swift']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['swift']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3666,7 +3806,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3696,7 +3836,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | | `fromat` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💠'` | A format string shown before the terraform workspace. | | `symbol` | `'💠'` | A format string shown before the terraform workspace. |
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3714,7 +3854,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3750,7 +3890,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | The format string for the module. | | `fromat` | `'at [$time]($style) '` | The format string for the module. |
| `use_12hr` | `false` | Enables 12 hour formatting | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `'bold yellow'` | The style for the module time | | `style` | `'bold yellow'` | The style for the module time |
@ -3767,7 +3907,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de
| time | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3803,7 +3943,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| ------------- | ----------------------- | ------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `'bold red'` | The style used when the user is root/admin. | | `style_root` | `'bold red'` | The style used when the user is root/admin. |
| `style_user` | `'bold yellow'` | The style used for non-root users. | | `style_user` | `'bold yellow'` | The style used for non-root users. |
| `format` | `'[$user]($style) in '` | Format dari modul. | | `fromat` | `'[$user]($style) in '` | Format dari modul. |
| `show_always` | `false` | Always shows the `username` module. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. | | `disabled` | `false` | Disables the `username` module. |
@ -3837,7 +3977,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. | | `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3854,7 +3994,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -3876,7 +4016,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'V '` | A format string representing the symbol of V | | `symbol` | `'V '` | A format string representing the symbol of V |
| `detect_extensions` | `['v']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `['v']` | Ekstensi mana yang sebaiknya memicu modul ini. |
@ -3911,7 +4051,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
| ---------- | -------------------------------- | ------------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | `''` | The symbol used before displaying the repository name. | | `symbol` | `''` | The symbol used before displaying the repository name. |
| `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. |
| `format` | `'vcsh [$symbol$repo]($style) '` | Format dari modul. | | `fromat` | `'vcsh [$symbol$repo]($style) '` | Format dari modul. |
| `disabled` | `false` | Disables the `vcsh` module. | | `disabled` | `false` | Disables the `vcsh` module. |
### Variabel ### Variabel
@ -3943,7 +4083,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. | | `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. |
| `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. |
@ -3960,7 +4100,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
| symbol | | Menyalin nilai dari opsi `symbol` | | symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
### Contoh ### Contoh
@ -4016,13 +4156,13 @@ 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. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `deskripsi` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `description` | `'<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. |
| `symbol` | `''` | The symbol used before displaying the command output. | | `symbol` | `''` | The symbol used before displaying the command output. |
| `style` | `'bold green'` | Gaya penataan untuk modul. | | `style` | `'bold green'` | Gaya penataan untuk modul. |
| `format` | `'[$symbol($output )]($style)'` | Format dari modul. | | `fromat` | `'[$symbol($output )]($style)'` | Format dari modul. |
| `disabled` | `false` | Disables this `custom` module. | | `disabled` | `false` | Disables this `custom` module. |
| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |
@ -4036,7 +4176,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| symbol | Menyalin nilai dari opsi `symbol` | | symbol | Menyalin nilai dari opsi `symbol` |
| style\* | Menyalin nilai dari opsi `style` | | style\* | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: This variable can only be used as a part of a style string
#### Custom command shell #### Custom command shell

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="Status alur kerja GitHub Actions" alt="Status alur kerja GitHub Actions"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan dengan menjalankan `$nu.config-path`): Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan dengan menjalankan `$nu.config-path`):
@ -340,7 +340,7 @@ Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan deng
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### Installation ### Pemasangan
```powershell ```powershell
choco install starship choco install starship
@ -29,7 +29,7 @@ choco install starship
pkg install getconf pkg install getconf
``` ```
### Installation ### Pemasangan
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin 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) ## [Funtoo Linux](https://www.funtoo.org/Welcome)
### Installation ### Pemasangan
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: 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:

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -24,15 +24,15 @@ Invoke-Expression (&starship init powershell)
Enable-TransientPrompt Enable-TransientPrompt
``` ```
## TransientPrompt and TransientRightPrompt in Cmd ## TransientPrompt e TransientRightPrompt in Cmd
Clink allows you to replace the previous-printed prompt with custom strings. È utile nei casi in cui alcune informazioni sulla shell non ci servono. To enable this, run `clink set prompt.transient <value>` where \<value\> can be one of: È possibile rimpiazzare il prompt precedente con una stringa di testo personalizzata. È utile nei casi in cui alcune informazioni sulla shell non ci servono. Per attivarlo, esegui `clink set prompt.transient <value>` dove \<value\> può essere uno tra:
- `always`: always replace the previous prompt - `always`: sostituisce sempre il prompt precedente
- `same_dir`: replace the previous prompt only if the working directory is same - `same_dir`: sostituisce il prompt precedente solo se la directory di lavoro è la stessa
- `off`: do not replace the prompt (i.e. turn off transience) - `off`: non sostituisce il prompt (cioè disattiva la transizione)
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: Devi fare questo solo una volta. Fai le seguenti modifiche alla tua `starship.lua` per personalizzare ciò che viene visualizzato a sinistra e a destra:
- Per impostazione predefinita, il simbolo predefinito prima dell'input sarà rimpiazzato con `>`. 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. Ad esempio, per mostrare il modulo dei `character`, dovresti fare - Per impostazione predefinita, il simbolo predefinito prima dell'input sarà rimpiazzato con `>`. 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. Ad esempio, per mostrare il modulo dei `character`, dovresti fare
@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Esempio ### Esempio
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Stile delle Stringhe ## Stile delle Stringhe

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Lo stile per il modulo. |
| `detect_extensions` | `[fnl]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. |
### Variables
| Variable | Esempio | Descrizione |
| --------- | -------- | ------------------------------------ |
| 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
### Esempio
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 AA -------------------------------------------- BB -------------------------------------------- CC
``` ```
## Fossil Branch
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `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'` | Lo stile per il modulo. |
| `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
| Variable | Esempio | Descrizione |
| --------- | ------- | ------------------------------------ |
| 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
### Esempio
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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.
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `["gradle"]` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `"bold bright-cyan"` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
### Variables
| Variable | Esempio | Descrizione |
| -------- | -------- | ------------------------------------ |
| 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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.
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `'bold purple'` | Lo stile per il modulo. | | `style` | `'bold purple'` | Lo stile per il modulo. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | Lo stile per il modulo. | | `style` | `'bold blue'` | Lo stile per il modulo. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2845,8 +2970,8 @@ The `package` module is shown when the current directory is the repository for a
| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
| `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` |
| `style` | `'bold 208'` | Lo stile per il modulo. | | `style` | `'bold 208'` | Lo stile per il modulo. |
| `display_private` | `false` | Abilita la visualizzazione della versione per i pacchetti contrassegnati come privati. | | `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disabilita il modulo `package`. | | `disabled` | `false` | Disables the `package` module. |
### Variables ### Variables
@ -2880,9 +3005,9 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | | `format` | `'via [$symbol($version )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` |
| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | | `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl |
| `detect_extensions` | `['pl', 'pm', 'pod']` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['pl', 'pm', 'pod']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Quali nomi di file dovrebbero attivare questo modulo. |
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' format = 'via [🔹 $version](147 bold) '
``` ```
## Pijul Channel
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
| `style` | `'bold purple'` | Lo stile per il modulo. |
| `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 ## Pulumi
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.
@ -3015,9 +3155,9 @@ The `purescript` module shows the currently installed version of [PureScript](ht
### 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`, `minore`, & `patch` | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | | `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. |
| `detect_extensions` | `['purs']` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['purs']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `['spago.dhall']` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `['spago.dhall']` | Quali nomi di file dovrebbero attivare questo modulo. |
@ -3764,7 +3904,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | ---------- | ----------------------------------- | | --------- | ---------- | ----------------------------------- |
| ora | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| 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
@ -3878,12 +4018,12 @@ The `vlang` module shows you your currently installed version of [V](https://vla
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `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` | `'V '` | Una stringa di formato che rappresenta il simbolo di V | | `symbol` | `'V '` | A format string representing the symbol of V |
| `detect_extensions` | `['v']` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `['v']` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `'blu grassetto'` | Lo stile per il modulo. | | `style` | `'blu grassetto'` | Lo stile per il modulo. |
| `disabled` | `false` | Disabilita il modulo `vlang`. | | `disabled` | `false` | Disables the `vlang` module. |
### Variables ### Variables
@ -4016,7 +4156,7 @@ 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. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `descrizione` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `description` | `'<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. |

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="GitHub Actions workflow status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
@ -340,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -4,7 +4,7 @@ heroImage: /logo.svg
heroText: heroText:
tagline: シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです! tagline: シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです!
actionText: Get Started → actionText: Get Started →
actionLink: ./ja-JP/guide/ actionLink: ./guide/
features: features:
- -
title: 互換性優先 title: 互換性優先
@ -149,14 +149,14 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
::: warning ::: warning
これは将来的に変更される可能性があります。 Nushell v0.61+ のみサポートされています。 これは将来的に変更される可能性があります。 Nushell v0.73+ のみサポートされています。
::: :::
そして、Nushellの設定ファイルの最後に以下を追加してください `$nu.env-path` を実行してください): Nushellの環境ファイルの最後に以下を追記してください ( `$nu.env-path` を実行してください):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
そして、Nushellの設定ファイルの最後に以下を追記してください (`$nu.config-path` を実行してください): そして、Nushellの設定ファイルの最後に以下を追記してください (`$nu.config-path` を実行してください):

View File

@ -91,7 +91,7 @@ function starship_preprompt_user_func(prompt)
print("🚀") print("🚀")
end end
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a")()
``` ```
- To run a custom function right before a command is executed, define a new function called `starship_precmd_user_func`. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do - To run a custom function right before a command is executed, define a new function called `starship_precmd_user_func`. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do
@ -207,8 +207,6 @@ Invoke-Expression (&starship init powershell)
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. `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 ```toml
@ -231,7 +229,7 @@ right_format = """$all"""
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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## スタイルの設定 ## スタイルの設定

File diff suppressed because it is too large Load Diff

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="GitHub Actions workflow status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Nushellの環境ファイルの最後に以下を追記してください ( `$nu
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
そして、Nushellの設定ファイルの最後に以下を追加してください `$nu.config-path` を実行してください)。 そして、Nushellの設定ファイルの最後に以下を追加してください `$nu.config-path` を実行してください)。
@ -340,7 +340,7 @@ starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
注意: Elvish v0.61以降でサポートされています 注意: Elvish v0.73以降でサポートされています
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -14,7 +14,11 @@
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Example ### Example
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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
| Variable | Example | 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' 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 ## Pulumi
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.

View File

@ -9,8 +9,8 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="깃헙 액션 워크풀로 상태" alt="GitHub Actions 워크플로 상태"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
><img ><img
@ -25,7 +25,7 @@
<a href="https://discord.gg/starship" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="디스코드에 채팅을 하세요" alt="Discord 채팅 참여하기"
/></a> /></a>
<a href="https://twitter.com/StarshipPrompt" <a href="https://twitter.com/StarshipPrompt"
><img ><img
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
@ -340,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -1,8 +1,8 @@
# Advanced Installation # 고급 설치
To install starship, you need to do two things: Starship을 설치하려면 다음 두 가지를 수행해주세요
1. Get the **starship** binary onto your computer 1. **Starship** 바이너리를 당신의 컴퓨터에 받으세요
1. Tell your shell to use the starship binary as its prompt by modifying its init scripts 1. Tell your shell to use the starship binary as its prompt by modifying its init scripts
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
@ -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. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### Installation ### 설치
```powershell ```powershell
choco install starship choco install starship
@ -29,7 +29,7 @@ choco install starship
pkg install getconf pkg install getconf
``` ```
### Installation ### 설치
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin 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) ## [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: 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:

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Example ### Example
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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
| Variable | Example | 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' 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 ## Pulumi
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.

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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-werkwijze status" alt="GitHub Actions-werkwijze status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -36,7 +36,9 @@
<p align="center"> <p align="center">
<a href="https://starship.rs">Website</a> <a href="https://starship.rs">Website</a>
·
<a href="#🚀-installation">Installatie</a> <a href="#🚀-installation">Installatie</a>
·
<a href="https://starship.rs/config/">Configuratie</a> <a href="https://starship.rs/config/">Configuratie</a>
</p> </p>
@ -150,12 +152,12 @@
**De minimalistische, razend snelle en oneindig aanpasbare prompt voor elke shell!** **De minimalistische, razend snelle en oneindig aanpasbare prompt voor elke shell!**
- **Snel:** het is snel -_echt heel erg_ snel! 🚀 - **Snel:** het is snel -_ echt heel_ snel! 🚀
- **Aanpasbaar:** configureer elk aspect van je prompt. - **Aanpasbaar:** configureer elk onderdeel van je prompt.
- **Universeel:** werkt op elke shell, op elk besturingssysteem. - **Universeel:** werkt op elke shell, op elk besturingssysteem.
- **Intelligent:** toont relevante informatie in een oogopslag. - **Intelligent:** toont relevante informatie in een oogopslag.
- **Rijk aan functies:** ondersteuning voor al je favoriete tools. - **Rijk aan functies:** ondersteuning voor al je favoriete tools.
- **Makkelijk:** snel te installeren - begin in een handomdraai met het te gebruiken. - **Makkelijk:** snel te installeren  gebruik het binnen enkele minuten.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Verken de Starship-documentatie&nbsp;&nbsp;</strong></a> <a href="https://starship.rs/config/"><strong>Verken de Starship-documentatie&nbsp;&nbsp;</strong></a>
@ -167,18 +169,18 @@
### Benodigdheden ### Benodigdheden
- Een [Nerd Font](https://www.nerdfonts.com/) is geïnstalleerd en ingeschakeld in je terminal (bijvoorbeeld probeer het [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - Een [Nerd Font](https://www.nerdfonts.com/) is geïnstalleerd en ingeschakeld in je terminal (probeer bijvoorbeeld het [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
### Step 1. Install Starship ### Stap 1. Installeer Starship
Select your operating system from the list below to view installation instructions: Selecteer je besturingssysteem in de onderstaande lijst en bekijk de installatie-instructies:
<details> <details>
<summary>Android</summary> <summary>Android</summary>
Install Starship using any of the following package managers: Installeer Starship met één van de volgende pakketbeheerders:
| Repository | Instructions | | Repository | Instructies |
| --------------------------------------------------------------------------------- | ---------------------- | | --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
@ -187,9 +189,9 @@ Install Starship using any of the following package managers:
<details> <details>
<summary>BSD</summary> <summary>BSD</summary>
Install Starship using any of the following package managers: Installeer Starship met één van de volgende pakketbeheerders:
| Distribution | Repository | Instructions | | Distribution | Repository | Instructies |
| ------------ | -------------------------------------------------------- | --------------------------------- | | ------------ | -------------------------------------------------------- | --------------------------------- |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | | FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
@ -208,7 +210,7 @@ curl -sS https://starship.rs/install.sh | sh
Alternatively, install Starship using any of the following package managers: Alternatively, install Starship using any of the following package managers:
| Distribution | Repository | Instructions | | Distribution | Repository | Instructies |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -235,7 +237,7 @@ curl -sS https://starship.rs/install.sh | sh
Alternatively, install Starship using any of the following package managers: Alternatively, install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructies |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -249,9 +251,9 @@ Alternatively, install Starship using any of the following package managers:
Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest).
Install Starship using any of the following package managers: Installeer Starship met één van de volgende pakketbeheerders:
| Repository | Instructions | | Repository | Instructies |
| -------------------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
@ -261,7 +263,7 @@ Install Starship using any of the following package managers:
</details> </details>
### Step 2. Setup your shell to use Starship ### Stap 2. Setup 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:
@ -329,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
@ -338,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -386,7 +388,7 @@ eval "$(starship init zsh)"
</details> </details>
### Step 3. Configure Starship ### Stap 3. Configure Starship
Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy!
@ -421,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### Installation ### Installatie
```powershell ```powershell
choco install starship choco install starship
@ -29,7 +29,7 @@ choco install starship
pkg install getconf pkg install getconf
``` ```
### Installation ### Installatie
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin 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) ## [Funtoo Linux](https://www.funtoo.org/Welcome)
### Installation ### Installatie
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: 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:

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -2,7 +2,7 @@
home: true home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! tagline: Minimal, blendende rask og uendelig tilpasningsdyktig ledetekst for alle skall!
actionText: Get Started → actionText: Get Started →
actionLink: ./guide/ actionLink: ./guide/
features: features:
@ -28,7 +28,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
</video> </video>
</div> </div>
### Prerequisites ### Nødvendig forutsetninger
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal.
@ -66,7 +66,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Bash #### Bash
Add the following to the end of `~/.bashrc`: Legg til følgende på slutten av `~/.bashrc`:
```sh ```sh
# ~/.bashrc # ~/.bashrc
@ -77,7 +77,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Fish #### Fish
Add the following to the end of `~/.config/fish/config.fish`: Legg til følgende i slutten av `~/.config/fish/config.fish`:
```sh ```sh
# ~/.config/fish/config.fish # ~/.config/fish/config.fish
@ -108,7 +108,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Ion #### Ion
Add the following to the end of `~/.config/ion/initrc`: Legg til følgende i slutten av `~/.config/ion/initrc`:
```sh ```sh
# ~/.config/ion/initrc # ~/.config/ion/initrc
@ -117,7 +117,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
``` ```
#### Elvish #### Elvisk
::: warning ::: warning
@ -125,7 +125,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: :::
Add the following to the end of `~/.elvish/rc.elv`: Legg til følgende i slutten av `~/.elvish/rc.elv`:
```sh ```sh
# ~/.elvish/rc.elv # ~/.elvish/rc.elv
@ -136,7 +136,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Tcsh #### Tcsh
Add the following to the end of `~/.tcshrc`: Legg til følgende i slutten av `~/.tcshrc`:
```sh ```sh
# ~/.tcshrc # ~/.tcshrc
@ -149,17 +149,17 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: warning
This will change in the future. Only Nushell v0.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): Legg til følgende i slutten av Nushell env filen (finn den ved å kjøre `$nu.env-path` i Nushell):
```sh ```sh
mkdir ~/.cache/starship 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`): Og legg følgende til slutten av Nushell konfigurasjonen (finn det ved å kjøre `$nu.config-path`):
```sh ```sh
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
@ -178,7 +178,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Cmd #### Cmd
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: Du må bruke [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) med Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
```lua ```lua
-- starship.lua -- starship.lua

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Example ### Example
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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
| Variable | Example | 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' 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 ## Pulumi
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.

View File

@ -2,44 +2,44 @@
<img <img
width="400" width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png" src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
alt="Starship Cross-shell prompt" alt="Starship kryssplattform ledetekst"
/> />
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="Github Handlinger arbeidsflyt status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
><img ><img
src="https://img.shields.io/crates/v/starship?style=flat-square" src="https://img.shields.io/crates/v/starship?style=flat-square"
alt="Crates.io version" alt="Crates.io versjon"
/></a> /></a>
<a href="https://repology.org/project/starship/versions" <a href="https://repology.org/project/starship/versions"
><img ><img
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Pakkestatus" /></a
><br /> ><br />
<a href="https://discord.gg/starship" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" alt="Chat Discord"
/></a> /></a>
<a href="https://twitter.com/StarshipPrompt" <a href="https://twitter.com/StarshipPrompt"
><img ><img
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Follow @StarshipPrompt on Twitter" alt="Følg @StarshipPrompt Twitter"
/></a> /></a>
</p> </p>
<p align="center"> <p align="center">
<a href="https://starship.rs">Website</a> <a href="https://starship.rs">Nettside</a>
· ·
<a href="#🚀-installation">Installation</a> <a href="#🚀-installation">Installasjon</a>
· ·
<a href="https://starship.rs/config/">Configuration</a> <a href="https://starship.rs/config/">Konfigurasjon</a>
</p> </p>
<p align="center"> <p align="center">
@ -47,7 +47,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
alt="English" alt="Engelsk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -55,7 +55,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
alt="Deutsch" alt="Tysk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -63,7 +63,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
alt="Español" alt="Spansk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -71,7 +71,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
alt="Français" alt="Fransk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -79,7 +79,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
alt="Bahasa Indonesia" alt="Bahasa-indonesisk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -87,7 +87,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
alt="Italiano" alt="Italiensk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -95,7 +95,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
alt="日本語" alt="Japansk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -103,7 +103,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
alt="Português do Brasil" alt="Portugisisk - Brasil"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -111,7 +111,7 @@
><img ><img
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="Russisk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -119,7 +119,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="Vietnamesisk"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -127,7 +127,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="Kinesisk - forenklet"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -135,7 +135,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="Kinesisk - tradisjonelt"
/></a> /></a>
</p> </p>
@ -145,42 +145,42 @@
<img <img
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
alt="Starship with iTerm2 and the Snazzy theme" alt="Starship med iTerm2 og Snazzy tema"
width="50%" width="50%"
align="right" align="right"
/> />
**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** **Minimal, blendende rask og uendelig tilpasningsdyktig ledetekst for alle skall! **
- **Fast:** it's fast _really really_ fast! 🚀 - **Fast:** Det er kjapt - _virkelig_ kjapt! 🚀
- **Customizable:** configure every aspect of your prompt. - **Tilpassbart:** konfigurer hvert aspekt av din ledetekst.
- **Universal:** works on any shell, on any operating system. - **Universelt:** fungerer med ethvert skall uansett operativsystem.
- **Intelligent:** shows relevant information at a glance. - **Intelligent:** viser relevant informasjon øyeblikkelig.
- **Feature rich:** support for all your favorite tools. - **Funksjonsrikt:** støtter alle dine favorittverktøy.
- **Easy:** quick to install  start using it in minutes. - **Lett:** raskt å installere - start å bruke det på minutter.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Explore the Starship docs&nbsp;&nbsp;</strong></a> <a href="https://starship.rs/config/"><strong>Utforsk Starship dokumentasjon&nbsp;&nbsp;</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>
## 🚀 Installation ## 🚀 Installasjon
### Prerequisites ### Nødvendig forutsetninger
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - En [Nerd Font](https://www.nerdfonts.com/) installert og aktivert i terminalen (for eksempel [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
### Step 1. Install Starship ### Steg 1. Installer Starship
Select your operating system from the list below to view installation instructions: Velg operativsystemet ditt fra listen nedenfor for å se installasjonsinstrukser:
<details> <details>
<summary>Android</summary> <summary>Android</summary>
Install Starship using any of the following package managers: Installer Starship ved å bruke en av følgende installasjonsprogrammene:
| Repository | Instructions | | Repository | Instruksjoner |
| --------------------------------------------------------------------------------- | ---------------------- | | --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
@ -189,11 +189,11 @@ Install Starship using any of the following package managers:
<details> <details>
<summary>BSD</summary> <summary>BSD</summary>
Install Starship using any of the following package managers: Installer Starship ved å bruke en av følgende installasjonsprogrammene:
| Distribution | Repository | Instructions | | Distribusjonen | Repository | Instruksjoner |
| ------------ | -------------------------------------------------------- | --------------------------------- | | -------------- | -------------------------------------------------------- | --------------------------------- |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Noen_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | | FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` | | NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
@ -210,12 +210,12 @@ curl -sS https://starship.rs/install.sh | sh
Alternatively, install Starship using any of the following package managers: Alternatively, install Starship using any of the following package managers:
| Distribution | Repository | Instructions | | Distribusjonen | Repository | Instruksjoner |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Noen_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | _Noen_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| _Any_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | | _Noen_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
| _Any_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` | | _Noen_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` |
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | | Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
| Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` | | Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` |
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
@ -237,7 +237,7 @@ curl -sS https://starship.rs/install.sh | sh
Alternatively, install Starship using any of the following package managers: Alternatively, install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instruksjoner |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -251,9 +251,9 @@ Alternatively, install Starship using any of the following package managers:
Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest).
Install Starship using any of the following package managers: Installer Starship ved å bruke en av følgende installasjonsprogrammene:
| Repository | Instructions | | Repository | Instruksjoner |
| -------------------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
@ -263,14 +263,14 @@ Install Starship using any of the following package managers:
</details> </details>
### Step 2. Setup your shell to use Starship ### Steg 2. Sett opp skallet ditt for å bruke Starship
Configure your shell to initialize starship. Select yours from the list below: Konfigurer skallet ditt til å initialisere starship. Velg din fra listen nedenfor:
<details> <details>
<summary>Bash</summary> <summary>Bash</summary>
Add the following to the end of `~/.bashrc`: Legg til følgende på slutten av `~/.bashrc`:
```sh ```sh
eval "$(starship init bash)" eval "$(starship init bash)"
@ -281,7 +281,7 @@ eval "$(starship init bash)"
<details> <details>
<summary>Cmd</summary> <summary>Cmd</summary>
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: Du må bruke [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) med Cmd. Lag en fil på følgende lokasjonen `%LocalAppData%\clink\starship.lua` med dette innholdet:
```lua ```lua
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
@ -290,22 +290,22 @@ load(io.popen('starship init cmd'):read("*a"))()
</details> </details>
<details> <details>
<summary>Elvish</summary> <summary>Elvisk</summary>
Add the following to the end of `~/.elvish/rc.elv`: Legg til følgende i slutten av `~/.elvish/rc.elv`:
```sh ```sh
eval (starship init elvish) eval (starship init elvish)
``` ```
Note: Only Elvish v0.18+ is supported Merk: Bare Alvisk v0.18+ støttes
</details> </details>
<details> <details>
<summary>Fish</summary> <summary>Fish</summary>
Add the following to the end of `~/.config/fish/config.fish`: Legg til følgende i slutten av `~/.config/fish/config.fish`:
```fish ```fish
starship init fish | source starship init fish | source
@ -316,7 +316,7 @@ starship init fish | source
<details> <details>
<summary>Ion</summary> <summary>Ion</summary>
Add the following to the end of `~/.config/ion/initrc`: Legg til følgende i slutten av `~/.config/ion/initrc`:
```sh ```sh
eval $(starship init ion) eval $(starship init ion)
@ -327,27 +327,27 @@ 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): Legg til følgende i slutten av Nushell env filen (finn den ved å kjøre `$nu.env-path` i Nushell):
```sh ```sh
mkdir ~/.cache/starship 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`): Og legg følgende til slutten av Nushell konfigurasjonen (finn det ved å kjøre `$nu.config-path`):
```sh ```sh
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Merk: Bare Nushell v0.73+ støttes
</details> </details>
<details> <details>
<summary>PowerShell</summary> <summary>PowerShell</summary>
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): Legg til følgende i slutten av PowerShell-konfigurasjonen (finn den ved å kjøre `$PROFILE`):
```powershell ```powershell
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
@ -358,7 +358,7 @@ Invoke-Expression (&starship init powershell)
<details> <details>
<summary>Tcsh</summary> <summary>Tcsh</summary>
Add the following to the end of `~/.tcshrc`: Legg til følgende i slutten av `~/.tcshrc`:
```sh ```sh
eval `starship init tcsh` eval `starship init tcsh`
@ -388,7 +388,7 @@ eval "$(starship init zsh)"
</details> </details>
### Step 3. Configure Starship ### Steg 3. Configure Starship
Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy!
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -11,11 +11,11 @@ There are so many platforms out there that they didn't fit into the main README.
## [Chocolatey](https://chocolatey.org) ## [Chocolatey](https://chocolatey.org)
### Prerequisites ### Nødvendig forutsetninger
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### Installation ### Installasjon
```powershell ```powershell
choco install starship choco install starship
@ -23,13 +23,13 @@ choco install starship
## [termux](https://termux.com) ## [termux](https://termux.com)
### Prerequisites ### Nødvendig forutsetninger
```sh ```sh
pkg install getconf pkg install getconf
``` ```
### Installation ### Installasjon
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin 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) ## [Funtoo Linux](https://www.funtoo.org/Welcome)
### Installation ### Installasjon
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: 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:

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -6,7 +6,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png) ![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png)
### Prerequisites ### Nødvendig forutsetninger
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)

View File

@ -6,7 +6,7 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) ![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png)
### Prerequisites ### Nødvendig forutsetninger
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font)

View File

@ -6,7 +6,7 @@ This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/t
![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png) ![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png)
### Prerequisites ### Nødvendig forutsetninger
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal

View File

@ -149,14 +149,14 @@ description: Starship to minimalny, szybki i ekstremalnie konfigurowalny wiersz
::: warning ::: warning
Ten sposób zmieni się w przyszłości. Działa tylko na Nushell v0.61+. Ten sposób zmieni się w przyszłości. Działa tylko na Nushell v0.73+.
::: :::
Dodaj następujący kod na koniec Twojego pliku Nushell env (możesz go znaleźć uruchamiając `$nu.env-path` w Nushell): Dodaj następujący kod na koniec twojego pliku env Nushell (możesz go znaleść za pomocą `$nu.env-path` w Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`): Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`):

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Example ### Example
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `zmienne` | | The environment variable to be displayed. | | `zmienne` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
| Zmienne | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 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
| Zmienne | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Zmienne | Example | Description | | Zmienne | Example | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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
| Zmienne | Example | 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Zmienne | Example | Description | | Zmienne | Example | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' 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 ## Pulumi
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.

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="Status Github Actions" alt="Status Github Actions"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -139,7 +139,7 @@
/></a> /></a>
</p> </p>
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine) [![SWUbaner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
<h1></h1> <h1></h1>
@ -171,16 +171,16 @@
- Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i ustawiona w twoim terminalu (wypróbuj na przykład [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i ustawiona w twoim terminalu (wypróbuj na przykład [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
### Krok 1. Install Starship ### Krok 1. Zainstaluj Starship
Select your operating system from the list below to view installation instructions: Wybierz system operacyjny z poniższej listy, aby wyświetlić odpowiednie instrukcje instalacji:
<details> <details>
<summary>Android</summary> <summary>Android</summary>
Install Starship using any of the following package managers: Zainstaluj Starship używając dowolnego z następujących menedżerów pakietów:
| Repository | Instructions | | Repozytorium | Instrukcje |
| --------------------------------------------------------------------------------- | ---------------------- | | --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
@ -189,11 +189,11 @@ Install Starship using any of the following package managers:
<details> <details>
<summary>BSD</summary> <summary>BSD</summary>
Install Starship using any of the following package managers: Zainstaluj Starship używając dowolnego z następujących menedżerów pakietów:
| Distribution | Repository | Instructions | | Dystrybucja | Repozytorium | Instrukcje |
| ------------ | -------------------------------------------------------- | --------------------------------- | | ------------- | -------------------------------------------------------- | --------------------------------- |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Dowolna_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | | FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` | | NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
@ -202,21 +202,21 @@ Install Starship using any of the following package managers:
<details> <details>
<summary>Linux</summary> <summary>Linux</summary>
Install the latest version for your system: Zainstaluj najnowszą wersję dla swojego systemu:
```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: Alternatywnie, zainstaluj Starship używając dowolnego z następujących menedżerów pakietów:
| Distribution | Repository | Instructions | | Dystrybucja | Repozytorium | Instrukcje |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Dowolna_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | _Dowolna_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| _Any_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | | _Dowolna_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
| _Any_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` | | _Dowolna_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` |
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | | Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk dodaj starship` |
| Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` | | Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` |
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
@ -229,15 +229,15 @@ 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: Zainstaluj najnowszą wersję dla swojego systemu:
```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: Alternatywnie, zainstaluj Starship używając dowolnego z następujących menedżerów pakietów:
| Repository | Instructions | | Repozytorium | Instrukcje |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -249,11 +249,11 @@ Alternatively, install Starship using any of the following package managers:
<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). Zainstaluj najnowszą wersję dla swojego systemu używając instalatorów MSI z [sekcji Releases](https://github.com/starship/starship/releases/latest).
Install Starship using any of the following package managers: Zainstaluj Starship używając dowolnego z następujących menedżerów pakietów:
| Repository | Instructions | | Repozytorium | Instrukcje |
| -------------------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
@ -263,9 +263,9 @@ Install Starship using any of the following package managers:
</details> </details>
### Krok 2. Setup your shell to use Starship ### Krok 2. Skonfiguruj swoją powłokę, aby używała Starship
Configure your shell to initialize starship. Select yours from the list below: Skonfiguruj swoją powłokę, aby inicjowała Starship. Wybierz swoją z poniższej listy:
<details> <details>
<summary>Bash</summary> <summary>Bash</summary>
@ -281,7 +281,7 @@ eval "$(starship init bash)"
<details> <details>
<summary>Cmd</summary> <summary>Cmd</summary>
Musisz użyć [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) z Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: Musisz użyć [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) z Cmd. Utwórz plik na tej ścieżce `%LocalAppData%\clink\starship.lua` z następującą zawartością:
```lua ```lua
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
@ -298,7 +298,7 @@ Dodaj na koniec pliku `~/.elvish/rc.elv`:
eval (starship init elvish) eval (starship init elvish)
``` ```
Note: Only Elvish v0.18+ is supported Uwaga: Obsługiwany jest tylko Elvish w wersji v0.18 wzwyż
</details> </details>
@ -327,11 +327,11 @@ 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): Dodaj następujący kod na koniec twojego pliku env Nushell (możesz go znaleść za pomocą `$nu.env-path` w Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`): Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`):
@ -340,14 +340,14 @@ Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możes
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Uwaga: Obsługiwany jest tylko Nushell w wersji v0.73 wzwyż
</details> </details>
<details> <details>
<summary>PowerShell</summary> <summary>PowerShell</summary>
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): Dodaj następujący kod na końcu swojego pliku konfiguracyjnego PowerShell (możesz go znaleźć uruchamiając `$PROFILE`):
```powershell ```powershell
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
@ -388,41 +388,42 @@ eval "$(starship init zsh)"
</details> </details>
### Krok 3. Configure Starship ### Krok 3. Skonfiguruj Starship
Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! Uruchom nową instancję powłoki, żeby zobaczyć swój nowy, piękny wiersz poleceń. Jeśli wartości domyślne są dla Ciebie satysfakcjonujące, to życzymy miłej zabawy!
If you're looking to further customize Starship: Lecz jeśli chcesz nieco dostosować Starship:
- **[Configuration](https://starship.rs/config/)** learn how to configure Starship to tweak your prompt to your liking - **[Konfiguracja](https://starship.rs/config/)** Naucz się konfigurować Starship, by móc dostosować swój wiersz poleceń wedle uznania
- **[Presets](https://starship.rs/presets/)** get inspired by the pre-built configuration of others - **[Gotowe konfiguracje](https://starship.rs/presets/)** zainspiruj się konfiguracjami stworzonymi przez innych
## 🤝Wspomóż nas ## 🤝Wspomóż nas
Zawsze szukamy pomocy od osób **na każdym poziomie zaawansowania**! Jeśli potrzebujesz łatwiejszego wdrożenia w projekt, wypróbuj [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). Zawsze szukamy pomocy od osób **na każdym poziomie zaawansowania**! Jeśli potrzebujesz łatwiejszego wdrożenia w projekt, wypróbuj [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
Jeśli płynnie władasz językiem innym niż angielski, bardzo doceniamy każdą pomoc w tłumaczeniu dokumentacji. Jeśli chcesz pomóc, tłumaczenia można dodawać na [Starship Crowdin](https://translate.starship.rs/). Jeśli płynnie władasz językiem innym niż angielski, bardzo doceniamy każdą pomoc w tłumaczeniu dokumentacji. Jeśli chcesz pomóc, tłumaczenia można dodawać na [Crowdin Starship](https://translate.starship.rs/).
Jeżeli chcesz wspomóc tworzenie starship, zapoznaj się z naszym [Poradnikiem Współpracy](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Ponadto możesz wejść na nasz [serwer Discord](https://discord.gg/8Jzqu3T) i się przywitać. 👋 Jeżeli chcesz wspomóc tworzenie starship, zapoznaj się z naszym [Poradnikiem Współpracy](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Ponadto możesz wejść na nasz [serwer Discord](https://discord.gg/8Jzqu3T) i się przywitać. 👋
## 💭Inspiracje ## 💭Inspiracje
Zapoznaj się z wcześniejszymi projektami które zainspirowały nas do stworzenia starship. 🙏 Zapoznaj się z wcześniejszymi projektami, które zainspirowały nas do stworzenia starship. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** A ZSH prompt for astronauts. - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** Wiersz poleceń ZSH dla astronautów.
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** Cross-shell robbyrussell theme written in JavaScript. - **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Motyw robyrussell dla wielu powłok, napisany w JavaScript.
- **[reujab/silver](https://github.com/reujab/silver)** A cross-shell customizable powerline-like prompt with icons. - **[reujab/silver](https://github.com/reujab/silver)** - Wiersz polecenia typu Powerline z ikonami, działa na wielu różnych powłokach.
## ❤️ Sponsors ## ❤️ Sponsorzy
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website. Wspomóż ten projekt [stając się sponsorem](https://github.com/sponsors/starship). Twoja nazwa bądź logo pojawi się tutaj wraz z linkiem do Twojej witryny.
**Supporter Tier** **Poziom Supporter**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
::: warning ::: warning
Isto irá mudar no futuro. Somente Nushell v0.61+ é suportado. Isto irá mudar no futuro. Somente Nushell v0.73+ é suportado.
::: :::
Adicione o seguinte ao final do seu arquivo env do Nushell (encontre-o executando `$nu.env-path` no Nushell): Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
E adicione o seguinte ao final da sua configuração do Nushell (encontre-o executando `$nu.config-path`): E adicione o seguinte ao final da sua configuração do Nushell (encontre-o executando `$nu.config-path`):

View File

@ -207,8 +207,6 @@ Nota: O prompt direito é uma única linha após o local de entrada. Para alinha
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Exemplo ### Exemplo
```toml ```toml
@ -231,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`. O prompt padrão é `"[∙](bright-black) "`. Starship pode definir o prompt de continuação usando a opção `continuation_prompt`. The default prompt is `'[∙](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.
@ -247,7 +245,7 @@ Nota: os prompts de continuação estão disponíveis apenas nos seguintes shell
# ~/.config/starship.toml # ~/.config/starship.toml
# Um prompt de continuação que exibe duas setas preenchidas # Um prompt de continuação que exibe duas setas preenchidas
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Estilo dos textos ## Estilo dos textos

File diff suppressed because it is too large Load Diff

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="Status do workflow Actions do GitHub" alt="Status do workflow Actions do GitHub"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
E adicione o seguinte ao final da sua configuração do Nushell (encontre-o executando `$nu.config-path`): E adicione o seguinte ao final da sua configuração do Nushell (encontre-o executando `$nu.config-path`):
@ -340,7 +340,7 @@ E adicione o seguinte ao final da sua configuração do Nushell (encontre-o exec
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Nota: Somente o Nushell v0.61+ é suportado Nota: Somente o Nushell v0.73+ é suportado
</details> </details>
@ -423,6 +423,7 @@ Apoie este projeto [tornando-se um patrocinador](https://github.com/sponsors/sta
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -14,7 +14,11 @@ Essa predefinição altera os símbolos para cada módulo usar símbolos com Ner
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. 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) [Click to view No Nerd Font preset](./no-nerd-font)
@ -34,7 +38,7 @@ Essa personalização converte os símbolos para cada módulo em texto simples.
Esta predefinição oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, esta aqui é para você! Esta predefinição oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, esta aqui é para você!
[![Captura da tela de predefinição Ocultar Versões de 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) ## [No Empty Icons](./no-empty-icons.md)
@ -44,7 +48,7 @@ This preset does not show icons if the toolset is not found.
## [Prompt do Terminal com Pure](./pure-preset.md) ## [Prompt do Terminal com Pure](./pure-preset.md)
Essa configuração simula a aparência e o comportamento do [Pure](https://github.com/sindresorhus/pure). Essa personalização simula a aparência e o comportamento do [Pure](https://github.com/sindresorhus/pure).
[![Captura de tela da personalização do prompt do terminal usando Pure](/presets/img/pure-preset.png "Clique para ver as personalização para usar no prompt do terminal com Pure")](./pure-preset) [![Captura de tela da personalização do prompt do terminal usando Pure](/presets/img/pure-preset.png "Clique para ver as personalização para usar no prompt do terminal com Pure")](./pure-preset)

View File

@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Example ### Example
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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
| Variable | Example | 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' 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 ## Pulumi
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.

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="GitHub Actions workflow status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
@ -340,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship - минимальная, быстрая и бесконе
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -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. `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 ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Строки стиля ## Строки стиля

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------ | ---------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | Символ, используемый перед отображением значения переменной. | | `symbol` | `""` | Символ, используемый перед отображением значения переменной. |
| `variable` | | Отображаемая переменная окружения. | | `variable` | | Отображаемая переменная окружения. |
| `default` | | Значение отображаемое, когда выбранная переменная не определена. | | `default` | | Значение отображаемое, когда выбранная переменная не определена. |
| `format` | `'with [$env_value]($style) '` | Формат модуля. | | `format` | `"with [$env_value]($style) "` | Формат модуля. |
| `description` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
| `disabled` | `false` | Отключает модуль `env_var`. | | `disabled` | `false` | Отключает модуль `env_var`. |
### Переменные ### Переменные
@ -1388,7 +1399,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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'` | Стиль модуля. |
| `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. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v1.2.1` | The version of `fennel` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 AA -------------------------------------------- BB -------------------------------------------- CC
``` ```
## Fossil Branch
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol$branch]($style) '` | Формат модуля. 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'` | Стиль модуля. |
| `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. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------- | ------------------------------------ |
| branch | `trunk` | The active Fossil branch |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1501,23 +1586,23 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
very-long-project-name = 'vlpn' very-long-project-name = 'vlpn'
``` ```
## Ветвь Git ## Git Branch
Модуль `git_branch` показывает активную ветку репозитория в вашем текущей директории. The `git_branch` module shows the active branch of the repo in your current directory.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| -------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Формат модуля. Use `'$branch'` to refer to the current branch name. | | `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Формат модуля. Use `'$branch'` to refer to the current branch name. |
| `symbol` | `' '` | A format string representing the symbol of git branch. | | `symbol` | `' '` | A format string representing the symbol of git branch. |
| `style` | `'bold purple'` | Стиль модуля. | | `style` | `'bold purple'` | Стиль модуля. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. You can use `''` for no symbol. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
| `disabled` | `false` | Отключает модуль `git_branch`. | | `disabled` | `false` | Disables the `git_branch` module. |
### Переменные ### Переменные
@ -1551,20 +1636,21 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ |
| `commit_hash_length` | `7` | Длина отображаемого хэша коммита git. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `'[\($hash$tag\)]($style) '` | Формат модуля. | | `format` | `'[\($hash$tag\)]($style) '` | Формат модуля. |
| `style` | `'bold green'` | Стиль модуля. | | `style` | `'bold green'` | Стиль модуля. |
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | | `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |
| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | | `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |
| `disabled` | `false` | Отключает модуль `git_commit`. | | `disabled` | `false` | Disables the `git_commit` module. |
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | --------- | ----------------------------------- | | ---------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | hash | `b703eb3` | The current git commit hash |
| tag | `v1.0.0` | The tag name if showing tag info is enabled. |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -1579,9 +1665,9 @@ commit_hash_length = 4
tag_symbol = '🔖 ' tag_symbol = '🔖 '
``` ```
## Состояние Git ## Git State
Модуль `git_state` будет отображаться в директориях, являющимися частью репозитория git, и там, где выполняется операция, такие как: _REBASING_, _BISECTING_, и т. д. Если есть информация о прогрессе (например, REBASING 3/10), эта информация также будет показана. The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
### Опции ### Опции
@ -1596,7 +1682,7 @@ tag_symbol = '🔖 '
| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `'bold yellow'` | Стиль модуля. | | `style` | `'bold yellow'` | Стиль модуля. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Формат модуля. | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Формат модуля. |
| `disabled` | `false` | Отключает модуль `git_state`. | | `disabled` | `false` | Disables the `git_state` module. |
### Переменные ### Переменные
@ -1607,7 +1693,7 @@ tag_symbol = '🔖 '
| progress_total | `2` | The total operation progress | | progress_total | `2` | The total operation progress |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
::: tip ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -1648,7 +1734,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
| added_style\* | | Mirrors the value of option `added_style` | | added_style\* | | Mirrors the value of option `added_style` |
| deleted_style\* | | Mirrors the value of option `deleted_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -1662,7 +1748,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
## Статус Git ## Статус Git
Модуль `git_status` отображает символы, представляющие состояние репозитория в вашей текущей директории. The `git_status` module shows symbols representing the state of the repo in your current directory.
::: tip ::: tip
@ -1675,7 +1761,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `'='` | Эта ветка имеет конфликты слияния. | | `conflicted` | `'='` | This branch has merge conflicts. |
| `ahead` | `'⇡'` | The format of `ahead` | | `ahead` | `'⇡'` | The format of `ahead` |
| `behind` | `'⇣'` | The format of `behind` | | `behind` | `'⇣'` | The format of `behind` |
| `diverged` | `'⇕'` | The format of `diverged` | | `diverged` | `'⇕'` | The format of `diverged` |
@ -1688,7 +1774,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `deleted` | `'✘'` | The format of `deleted` | | `deleted` | `'✘'` | The format of `deleted` |
| `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` | Disables the `git_status` module. |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
### Переменные ### Переменные
@ -1708,7 +1794,7 @@ The following variables can be used in `format`:
| `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. |
| style\* | Отражает значение параметра `style` | | style\* | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
The following variables can be used in `diverged`: The following variables can be used in `diverged`:
@ -1720,8 +1806,8 @@ The following variables can be used in `diverged`:
The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:
| Переменная | Описание | | Переменная | Описание |
| ---------- | -------------------------- | | ---------- | ------------------------ |
| `count` | Показать количество файлов | | `count` | Show the number of files |
### Пример ### Пример
@ -1742,7 +1828,7 @@ renamed = '👅'
deleted = '🗑' deleted = '🗑'
``` ```
Показывать счетчик впереди/позади для отслеживаемой ветки Show ahead/behind count of the branch being tracked
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -1787,7 +1873,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
| `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`. | | `disabled` | `false` | Disables the `golang` module. |
### Переменные ### Переменные
@ -1828,7 +1914,7 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `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"` | Стиль модуля. |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v7.5.1` | The version of `gradle` |
| symbol | | Отражает значение параметра `symbol` |
| style* | | Отражает значение параметра `style` |
*: This variable can only be used as a part of a style string
## Haskell ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -1859,7 +1980,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. | | `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold purple'` | Стиль модуля. | | `style` | `'bold purple'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `haskell`. | | `disabled` | `false` | Disables the `haskell` module. |
### Переменные ### Переменные
@ -1954,24 +2075,24 @@ format = 'via [⎈ $version](bold white) '
## Имя хоста ## Имя хоста
Модуль `hostname` отображает имя системы (хоста). The `hostname` module shows the system hostname.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Показывать имя хоста только при подключении через SSH. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | Символы, по которую имя хоста будет сокращено после первого совпадения. `'.'` will stop after the first dot. `''` will disable any truncation | | `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | Формат модуля. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | Формат модуля. |
| `style` | `'bold dimmed green'` | Стиль модуля. | | `style` | `'bold dimmed green'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `hostname`. | | `disabled` | `false` | Disables the `hostname` module. |
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | ---------- | ----------------------------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| имя хоста | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | | ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |
@ -2007,7 +2128,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `'☕ '` | A format string representing the symbol of Java | | `symbol` | `'☕ '` | A format string representing the symbol of Java |
| `style` | `'red dimmed'` | Стиль модуля. | | `style` | `'red dimmed'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `java`. | | `disabled` | `false` | Disables the `java` module. |
### Переменные ### Переменные
@ -2017,7 +2138,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -2028,9 +2149,9 @@ The `java` module shows the currently installed version of [Java](https://www.or
symbol = '🌟 ' symbol = '🌟 '
``` ```
## Работы ## Jobs
Модуль `jobs` отображает текущее количество запущенных работ. Модуль будет показан только если работы выполняются в фоне. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running.
The default functionality is: The default functionality is:
@ -2054,13 +2175,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ |
| `threshold`* | `1` | Показывать количество работ, если превышено. | | `threshold`* | `1` | Show number of jobs if exceeded. |
| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |
| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |
| `format` | `'[$symbol$number]($style) '` | Формат модуля. | | `format` | `'[$symbol$number]($style) '` | Формат модуля. |
| `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. |
| `style` | `'bold blue'` | Стиль модуля. | | `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `jobs`. | | `disabled` | `false` | Disables the `jobs` module. |
*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.
@ -2153,7 +2274,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -2178,7 +2299,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
::: tip ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions.
@ -2196,7 +2317,7 @@ When the module is enabled it will always be active, unless any of `detect_exten
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `true` | Отключает модуль `kubernetes`. | | `disabled` | `true` | Disables the `kubernetes` module. |
### Переменные ### Переменные
@ -2209,7 +2330,7 @@ When the module is enabled it will always be active, unless any of `detect_exten
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -2259,15 +2380,15 @@ Long and automatically generated cluster names can be identified and shortened u
'gke_.*_(?P<var_cluster>[\\w-]+)' = 'gke-$var_cluster' 'gke_.*_(?P<var_cluster>[\\w-]+)' = 'gke-$var_cluster'
``` ```
## Разрыв Строки ## Line Break
Модуль `line_break` разделяет командную строку на две строки. The `line_break` module separates the prompt into two lines.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------ | ------------------------------------------------------------------------ | | ---------- | ------------ | ------------------------------------------------------------------ |
| `disabled` | `false` | Отключает модуль `line_break`, отображая командную строку в одну строку. | | `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
### Пример ### Пример
@ -2341,7 +2462,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -2352,27 +2473,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
format = 'via [🌕 $version](bold blue) ' format = 'via [🌕 $version](bold blue) '
``` ```
## Использование памяти ## Memory Usage
Модуль `memory_usage` отображает текущую системную память и использование подкачки. 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 ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ----------- | ----------------------------------------------- | ------------------------------------------------------------------ | | ----------- | ----------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Скрывать использование памяти, если она не превышает этот процент. | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Формат модуля. | | `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Формат модуля. |
| `symbol` | `'🐏'` | Символ, используемый перед отображением использования памяти. | | `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |
| `style` | `'bold dimmed white'` | Стиль модуля. | | `style` | `'bold dimmed white'` | Стиль модуля. |
| `disabled` | `true` | Отключает модуль `memory_usage`. | | `disabled` | `true` | Disables the `memory_usage` module. |
### Переменные ### Переменные
@ -2438,26 +2559,27 @@ symbol = ' '
style = 'bold dimmed green' style = 'bold dimmed green'
``` ```
## Ветвь Mercurial ## Mercurial Branch
Модуль `hg_branch` показывает активную ветку репозитория в вашей текущей директории. The `hg_branch` module shows the active branch and topic of the repo in your current directory.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | Символ, используемый перед закладкой hg или именем ветви репозитория в текущем каталоге. | | `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `'bold purple'` | Стиль модуля. | | `style` | `'bold purple'` | Стиль модуля. |
| `format` | `'on [$symbol$branch]($style) '` | Формат модуля. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | Формат модуля. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes |
| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Отключает модуль `hg_branch`. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ | | ---------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
@ -2487,7 +2609,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля | | `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` | `'👑 '` | The symbol used before displaying the version of Nim. | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. |
@ -2518,18 +2640,20 @@ symbol = '🎣 '
## Nix-shell ## Nix-shell
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. Модуль будет показываться внутри среды nix-shell. The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | Формат модуля. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | Формат модуля. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | Стиль модуля. | | `style` | `'bold blue'` | Стиль модуля. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
| `disabled` | `false` | Отключает модуль `nix_shell`. | | `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. |
### Переменные ### Переменные
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2576,7 +2701,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. | | `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | Стиль модуля. | | `style` | `'bold green'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `nodejs`. | | `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | | `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. |
### Переменные ### Переменные
@ -2703,7 +2828,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known
::: tip ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -2813,9 +2938,9 @@ Windows = " "
Arch = "Arch is the best! " Arch = "Arch is the best! "
``` ```
## Версия пакета ## Package Version
Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory - [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2842,11 +2967,11 @@ Arch = "Arch is the best! "
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | Формат модуля. | | `format` | `'is [$symbol$version]($style) '` | Формат модуля. |
| `symbol` | `'📦 '` | Символ, используемый перед отображением версии пакета. | | `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
| `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` |
| `style` | `'bold 208'` | Стиль модуля. | | `style` | `'bold 208'` | Стиль модуля. |
| `display_private` | `false` | Enable displaying version for packages marked as private. | | `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Отключает модуль `package`. | | `disabled` | `false` | Disables the `package` module. |
### Переменные ### Переменные
@ -2856,7 +2981,7 @@ Arch = "Arch is the best! "
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -2921,12 +3046,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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` | `'🐘 '` | Символ, используемый перед отображением версии PHP. | | `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. |
| `detect_extensions` | `['php']` | Which extensions should trigger this module. | | `detect_extensions` | `['php']` | Which extensions should trigger this module. |
| `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. | | `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'147 bold'` | Стиль модуля. | | `style` | `'147 bold'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `php`. | | `disabled` | `false` | Disables the `php` module. |
### Переменные ### Переменные
@ -2936,7 +3061,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' format = 'via [🔹 $version](147 bold) '
``` ```
## Pijul Channel
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
| `style` | `'bold purple'` | Стиль модуля. |
| `format` | `'on [$symbol$channel]($style) '` | Формат модуля. |
| `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 ## Pulumi
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.
@ -2976,10 +3116,10 @@ By default the module will be shown if any of the following conditions are met:
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------------- | ---------- | ------------------------------------ | | ---------- | ---------- | ------------------------------------ |
| version | `v0.12.24` | The version of `pulumi` | | version | `v0.12.24` | The version of `pulumi` |
| stack | `dev` | The current Pulumi stack | | stack | `dev` | The current Pulumi stack |
| имя пользователя | `alice` | The current Pulumi username | | username | `alice` | The current Pulumi username |
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
@ -3033,7 +3173,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3070,7 +3210,7 @@ By default the module will be shown if any of the following conditions are met:
| `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 Python | | `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | Стиль модуля. | | `style` | `'yellow bold'` | Стиль модуля. |
| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | Which extensions should trigger this module | | `detect_extensions` | `['py']` | Which extensions should trigger this module |
@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) '
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension - The current directory contains a file with `.red` or `.reds` extension
@ -3240,7 +3380,7 @@ By default the `red` module shows the currently installed version of [Red](https
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3253,7 +3393,7 @@ symbol = '🔴 '
## Ruby ## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `Gemfile` - Текущий каталог содержит файл `Gemfile`
- Текущий каталог содержит файл `.ruby-version` - Текущий каталог содержит файл `.ruby-version`
@ -3274,7 +3414,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. |
| `style` | `'bold red'` | Стиль модуля. | | `style` | `'bold red'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `ruby`. | | `disabled` | `false` | Disables the `ruby` module. |
### Переменные ### Переменные
@ -3297,7 +3437,7 @@ symbol = '🔺 '
## Rust ## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `Cargo.toml` - Текущий каталог содержит файл `Cargo.toml`
- Текущий каталог содержит файл с расширением `.rs` - Текущий каталог содержит файл с расширением `.rs`
@ -3313,7 +3453,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. | | `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold red'` | Стиль модуля. | | `style` | `'bold red'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `rust`. | | `disabled` | `false` | Disables the `rust` module. |
### Переменные ### Переменные
@ -3365,7 +3505,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3382,7 +3522,7 @@ The `shell` module shows an indicator for currently used shell.
::: tip ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -3410,7 +3550,7 @@ The `shell` module shows an indicator for currently used shell.
| Переменная | По умолчанию | Описание | | Переменная | По умолчанию | Описание |
| ---------- | ------------ | ---------------------------------------------------------- | | ---------- | ------------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Отражает значение параметра `style`. | | style\* | | Mirrors the value of option `style`. |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -3517,7 +3657,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3534,7 +3674,7 @@ The `status` module displays the exit code of the previous command. If $success_
::: tip ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -3573,7 +3713,7 @@ The `status` module displays the exit code of the previous command. If $success_
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3595,7 +3735,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module
::: tip ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -3640,7 +3780,7 @@ disabled = false
## Swift ## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
@ -3666,7 +3806,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3703,7 +3843,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. | | `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
| `style` | `'bold 105'` | Стиль модуля. | | `style` | `'bold 105'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `terraform`. | | `disabled` | `false` | Disables the `terraform` module. |
### Переменные ### Переменные
@ -3714,7 +3854,7 @@ By default the module will be shown if any of the following conditions are met:
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3738,24 +3878,24 @@ format = '[🏎💨 $workspace]($style) '
## Время ## Время
Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры. 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 ::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | The format string for the module. | | `format` | `'at [$time]($style) '` | The format string for the module. |
| `use_12hr` | `false` | Включить 12-часовое форматирование | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `'bold yellow'` | Стиль модуля времени | | `style` | `'bold yellow'` | The style for the module time |
| `utc_time_offset` | `'local'` | Устанавливает смещение UTC. Range from -24 &lt; x &lt; 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. | | `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Отключает модуль `time`. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting.
@ -3764,10 +3904,10 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------- |
| время | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3782,9 +3922,9 @@ utc_time_offset = '-5'
time_range = '10:00:00-14:00:00' time_range = '10:00:00-14:00:00'
``` ```
## Имя пользователя ## Username
Модуль `username` показывает имя текущего пользователя. Модуль будет показан, если любое из следующих условий соблюдено: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- Текущий пользователь отличается от залогиненного - Текущий пользователь отличается от залогиненного
@ -3800,12 +3940,12 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------- | ----------------------- | ------------------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `'bold red'` | The style used when the user is root/admin. | | `style_root` | `'bold red'` | The style used when the user is root/admin. |
| `style_user` | `'bold yellow'` | Стиль, используемый для всех пользователей, кроме root. | | `style_user` | `'bold yellow'` | The style used for non-root users. |
| `format` | `'[$user]($style) in '` | Формат модуля. | | `format` | `'[$user]($style) in '` | Формат модуля. |
| `show_always` | `false` | Всегда показывать модуль `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Отключает модуль `username`. | | `disabled` | `false` | Disables the `username` module. |
### Переменные ### Переменные
@ -3854,7 +3994,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) '
## Zig ## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -3960,7 +4100,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
| symbol | | Отражает значение параметра `symbol` | | symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
### Пример ### Пример
@ -4016,7 +4156,7 @@ 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. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `описание` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `description` | `'<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. |
@ -4036,7 +4176,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| symbol | Отражает значение параметра `symbol` | | symbol | Отражает значение параметра `symbol` |
| style\* | Отражает значение параметра `style` | | style\* | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: This variable can only be used as a part of a style string
#### Custom command shell #### Custom command shell

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="GitHub Actions workflow status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
@ -340,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
### Installation ### Установка
```powershell ```powershell
choco install starship choco install starship
@ -29,7 +29,7 @@ choco install starship
pkg install getconf pkg install getconf
``` ```
### Installation ### Установка
```sh ```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin 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) ## [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: 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:

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship, her prompt için minimal, son derece hızlı ve son derec
::: warning ::: 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): Nushell env dosyanızın sonuna aşağıdakileri ekleyin (Nushell'de `$nu.env-path` komutunu çalıştırarak bulabilirsiniz):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşabilirsiniz) sonuna ekleyin: Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşabilirsiniz) sonuna ekleyin:

View File

@ -206,8 +206,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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Example ### Example
```toml ```toml
@ -230,7 +228,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). 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. Note: `continuation_prompt` should be set to a literal string without any variables.
@ -246,7 +244,7 @@ Note: Continuation prompts are only available in the following shells:
# ~/.config/starship.toml # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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. |
| `stil` | `'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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 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. |
| `stil` | `'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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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. |
| `stil` | `"bold bright-cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
### Variables
| Variable | Example | 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. 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. - 1 job -> `symbol` is shown.
- 2 jobs or more -> `symbol` + `number` are shown. - 2 jobs or more -> `symbol` + `number` are shown.
::: warning ::: uyarı
This module is not supported on tcsh and nu. This module is not supported on tcsh and nu.
::: :::
::: warning ::: uyarı
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. 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,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `stil` | `'bold purple'` | The style for the module. | | `stil` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `stil` | `'bold blue'` | The style for the module. | | `stil` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' 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. The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
::: warning ::: uyarı
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. 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) ' 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. |
| `stil` | `'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 ## Pulumi
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.

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="GitHub Actions workflow status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Nushell env dosyanızın sonuna aşağıdakileri ekleyin (Nushell'de `$nu.env-pa
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşabilirsiniz) sonuna ekleyin: Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşabilirsiniz) sonuna ekleyin:
@ -340,7 +340,7 @@ Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşab
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Not: Nushell v0.61'tan sonraki sürümler desteklenmektedir Not: Nushell v0.73'tan sonraki sürümler desteklenmektedir
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: warning ::: 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 ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Додайте наступний рядок наприкінці Вашої конфігурації Nushell (знайдіть її виконавши `$nu.config-path`): Додайте наступний рядок наприкінці Вашої конфігурації Nushell (знайдіть її виконавши `$nu.config-path`):

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Example ### Example
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Style Strings ## Style Strings

View File

@ -252,12 +252,14 @@ $singularity\
$kubernetes\ $kubernetes\
$directory\ $directory\
$vcsh\ $vcsh\
$fossil_branch\
$git_branch\ $git_branch\
$git_commit\ $git_commit\
$git_state\ $git_state\
$git_metrics\ $git_metrics\
$git_status\ $git_status\
$hg_branch\ $hg_branch\
$pijul_channel\
$docker_context\ $docker_context\
$package\ $package\
$c\ $c\
@ -270,6 +272,7 @@ $dotnet\
$elixir\ $elixir\
$elm\ $elm\
$erlang\ $erlang\
$fennel\
$golang\ $golang\
$guix_shell\ $guix_shell\
$haskell\ $haskell\
@ -278,6 +281,7 @@ $helm\
$java\ $java\
$julia\ $julia\
$kotlin\ $kotlin\
$gradle\
$lua\ $lua\
$nim\ $nim\
$nodejs\ $nodejs\
@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab
::: tip ::: 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. 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 Example: following configuration will display value of USER environment variable
@ -1321,11 +1331,12 @@ default = 'unknown user'
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `''` | The symbol used before displaying the variable value. | | `symbol` | `""` | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `'with [$env_value]($style) '` | The format for the module. | | `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. | | `disabled` | `false` | Disables the `env_var` module. |
### Variables ### Variables
@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = 'via [e $version](bold red) ' 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill ## 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. 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 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
| Variable | Example | 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
### Example
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Google Cloud (`gcloud`) ## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@ -1563,8 +1648,9 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | --------- | ----------------------------------- | | --------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash | | 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` | | 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
@ -1840,6 +1926,41 @@ disabled = true
format = 'via [🐂](yellow bold) ' 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
| Variable | Example | 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 ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
@ -2440,24 +2561,25 @@ style = 'bold dimmed green'
## Mercurial Branch ## 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 ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `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. | | `style` | `'bold purple'` | The style for the module. |
| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | | `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `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. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
| `disabled` | `true` | Disables the `hg_branch` module. | | `disabled` | `true` | Disables the `hg_branch` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | -------- | ------------------------------------ | | --------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch | | branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -2523,13 +2645,15 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | | `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | The style for the module. | | `style` | `'bold blue'` | The style for the module. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `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. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Variables ### Variables
@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
disabled = true disabled = true
impure_msg = '[impure shell](bold red)' impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)' pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) ' format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
format = 'via [🔹 $version](147 bold) ' 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 ## Pulumi
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.

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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 workflow status" alt="GitHub Actions workflow status"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu
``` ```
Додайте наступний рядок наприкінці Вашої конфігурації Nushell (знайдіть її виконавши `$nu.config-path`): Додайте наступний рядок наприкінці Вашої конфігурації Nushell (знайдіть її виконавши `$nu.config-path`):
@ -340,7 +340,7 @@ starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Примітка: Підтримується лише Nushell v0.61+ Примітка: Підтримується лише Nushell v0.73+
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

View File

@ -149,14 +149,14 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế
::: warning ::: 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 ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):

View File

@ -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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
Note: Nushell 0.71.0 or later is required
### Ví dụ ### Ví dụ
```toml ```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). 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. 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 # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶" continuation_prompt = '▶▶ '
``` ```
## Các chuỗi kiểu ## Các chuỗi kiểu

File diff suppressed because it is too large Load Diff

View File

@ -9,7 +9,7 @@
<p align="center"> <p align="center">
<a href="https://github.com/starship/starship/actions" <a href="https://github.com/starship/starship/actions"
><img ><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="Trạng thái GitHub Actions workflow" alt="Trạng thái GitHub Actions workflow"
/></a> /></a>
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
@ -331,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e
```sh ```sh
mkdir ~/.cache/starship 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
@ -340,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.61+ is supported Note: Only Nushell v0.73+ is supported
</details> </details>
@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
**Supporter Tier** **Supporter Tier**
- [Dimension](https://dimension.dev/) - [Dimension](https://dimension.dev/)
- [Appwrite](https://appwrite.io/)
<p align="center"> <p align="center">
<br> <br>

View File

@ -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. 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) [Click to view No Nerd Font preset](./no-nerd-font)

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