`dnf install starship` | -| Fedora +31 | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | | Manjaro | | `pacman -S starship` | | NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` | @@ -417,6 +416,14 @@ If you're looking to further customize Starship: - **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons. +## ❤️ Sponsors + +Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website. + +**Supporter Tier** + +- [Dimension](https://dimension.dev/) +
探索 Starship 文件 ▶
@@ -171,9 +171,9 @@
- 安裝至少一個 [Nerd Font](https://www.nerdfonts.com/) 字體，並在終端中啟用（例如，你可以試試 [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)）。
-### Step 1. Install Starship
+### 第一步 安裝 Starship
-Select your operating system from the list below to view installation instructions:
+瀏覽各系統的安裝指示
diff --git a/docs/ar-SA/presets/README.md b/docs/ar-SA/presets/README.md
index 26c2314bf..cb3dcf1bc 100644
--- a/docs/ar-SA/presets/README.md
+++ b/docs/ar-SA/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/ar-SA/presets/no-empty-icons.md b/docs/ar-SA/presets/no-empty-icons.md
new file mode 100644
index 000000000..7be6867d1
--- /dev/null
+++ b/docs/ar-SA/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuration
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/ar-SA/presets/no-nerd-font.md b/docs/ar-SA/presets/no-nerd-font.md
new file mode 100644
index 000000000..b154a6c00
--- /dev/null
+++ b/docs/ar-SA/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuration
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/ar-SA/presets/tokyo-night.md b/docs/ar-SA/presets/tokyo-night.md
new file mode 100644
index 000000000..883f79de0
--- /dev/null
+++ b/docs/ar-SA/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### المتطلبات الأساسية
+
+- تثبيت [Nerd Font](https://www.nerdfonts.com/) وتمكينه في موجه الأوامر الخاصة بك
+
+### Configuration
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/ckb-IR/advanced-config/README.md b/docs/ckb-IR/advanced-config/README.md
index 2935c582b..23c3bd21a 100644
--- a/docs/ckb-IR/advanced-config/README.md
+++ b/docs/ckb-IR/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
+
+Note: Nushell 0.71.0 or later is required
### نموونە
@@ -280,5 +282,5 @@ If multiple colors are specified for foreground/background, the last one in the
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md
index a351bc014..dcc6c1c40 100644
--- a/docs/ckb-IR/config/README.md
+++ b/docs/ckb-IR/config/README.md
@@ -15,15 +15,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+بۆ نموونە:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
@@ -80,9 +138,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
بۆ نموونە:
-- `$version` is a format string with a variable named `version`.
-- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
-- `$git_branch $git_commit` has the two variables separated with a space.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### کۆمەڵە نووسین
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
بۆ نموونە:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
بۆ نموونە:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ This is the list of prompt-wide configuration options.
| Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### نموونە
@@ -178,10 +213,10 @@ This is the list of prompt-wide configuration options.
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| گۆڕاو | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### نموونە
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
-| `full_symbol` | `" "` | The symbol shown when the battery is full. |
-| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
-| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
-| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | The symbol shown when the battery is full. |
+| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
+| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -423,9 +478,9 @@ The `battery` module shows how charged the device's battery is and its current c
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery Display
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The `display` option is an array of the following table.
| Option | Default | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `style` | `"red bold"` | The style used if the display option is in use. |
+| `style` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### نموونە
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `'bold red'` | The style for the module. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | The style for the module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | The style for the module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | The style for the module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
-| `symbol` | `"🅒 "` | The symbol used before the environment name. |
-| `style` | `"bold green"` | The style for the module. |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | The symbol used before the environment name. |
+| `style` | `'bold green'` | The style for the module. |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | The style for the module. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | The style for the module. |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | The style for the module. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `style` | `"bold cyan"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | The style for the module. |
+| `style` | `'green bold'` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
-| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `style` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | Default | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
+| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `style` | `'bold cyan'` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| گۆڕاو | نموونە | Description |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| گۆڕاو | نموونە | Description |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -413,6 +412,14 @@ If you're looking to further customize Starship:
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/ckb-IR/presets/README.md b/docs/ckb-IR/presets/README.md
index ee980d1f7..fd49eb65e 100644
--- a/docs/ckb-IR/presets/README.md
+++ b/docs/ckb-IR/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [پارچە کەوانەکراوەکان](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset changes the symbols for each module into plain text. Great if you do
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
ئەم پێش ڕێکخستنە لاسایی شێواز و ڕەفتاری [Pure](https://github.com/sindresorhus/pure) دەکاتەوە.
@@ -39,3 +53,9 @@ This preset changes the symbols for each module into plain text. Great if you do
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/ckb-IR/presets/no-empty-icons.md b/docs/ckb-IR/presets/no-empty-icons.md
new file mode 100644
index 000000000..ddc80c9ad
--- /dev/null
+++ b/docs/ckb-IR/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### ڕێکخستن
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/ckb-IR/presets/no-nerd-font.md b/docs/ckb-IR/presets/no-nerd-font.md
new file mode 100644
index 000000000..4d9d3a72c
--- /dev/null
+++ b/docs/ckb-IR/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### ڕێکخستن
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/ckb-IR/presets/tokyo-night.md b/docs/ckb-IR/presets/tokyo-night.md
new file mode 100644
index 000000000..3c1077eb3
--- /dev/null
+++ b/docs/ckb-IR/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### پێشمەرجەکان
+
+- [فۆنتێکی Nerd](https://www.nerdfonts.com/) دامەزراوە و چالاککراوە لە تێرمیناڵەکەتا
+
+### ڕێکخستن
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/config/README.md b/docs/config/README.md
index 426980cb2..b7a1f0d18 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -286,6 +286,7 @@ $erlang\
$golang\
$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -372,7 +373,7 @@ falls back to the `x_security_token_expires` key.
| Option | Default | Description |
| ------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | The style for the module. |
@@ -557,7 +558,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
| `version_format` | `'v${raw}'` | The version format. |
-| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
@@ -597,7 +598,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 Bun. |
+| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -703,7 +704,7 @@ are only supported in fish due to [upstream issues with mode detection in zsh](h
| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -786,7 +787,7 @@ By default, the module will be shown if any of the following conditions are met:
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold blue'` | The style for the module. |
@@ -939,7 +940,7 @@ By default the module will be shown if any of the following conditions are met:
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold red'` | The style for the module. |
@@ -1024,7 +1025,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
| `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 Dart |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
@@ -1063,7 +1064,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `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 Deno |
+| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -1110,7 +1111,7 @@ it would have been `nixpkgs/pkgs`.
| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
| `style` | `'bold cyan'` | The style for the module. |
| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
| `read_only_style` | `'red'` | The style for the read only symbol. |
| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
@@ -1192,7 +1193,7 @@ the context in use).
| Option | Default | Description |
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
-| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
+| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
| `only_with_files` | `true` | Only show when there's a match |
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
@@ -1252,7 +1253,7 @@ when there is a `.csproj` file in the current directory.
| Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `'via [$symbol($version )(🎯 $tfm )]($style)'` | The format for the module. |
+| `format` | `'via [$symbol($version )(🎯 $tfm )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'.NET '` | The symbol used before displaying the version of dotnet. |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
@@ -1297,7 +1298,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `'💧 '` | The symbol used before displaying the version of Elixir/Erlang. |
+| `symbol` | `'💧 '` | The symbol used before displaying the version of Elixir/Erlang. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['mix.exs']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
@@ -1341,7 +1342,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
| `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 Elm. |
+| `symbol` | `'🌳 '` | A format string representing the symbol of Elm. |
| `detect_extensions` | `['elm']` | Which extensions should trigger this module. |
| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['elm-stuff']` | Which folders should trigger this modules. |
@@ -1514,7 +1515,7 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc
| Option | Default | Description |
| ----------------- | -------------------------------------------------------- | ---------------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | The format for the module. |
-| `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. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `style` | `'bold blue'` | The style for the module. |
@@ -1867,7 +1868,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
+| `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
@@ -1903,7 +1904,7 @@ The module will be shown when inside a guix-shell environment.
| Option | Default | Description |
| ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | The format for the module. |
-| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. |
+| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | The style for the module. |
| `disabled` | `false` | Disables the `guix_shell` module. |
@@ -1959,6 +1960,47 @@ By default the module will be shown if any of the following conditions are met:
*: This variable can only be used as a part of a style string
+## Haxe
+
+The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/).
+By default the module will be shown if any of the following conditions are met:
+
+- The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file
+- The current directory contains a `.haxelib` or a `haxe_libraries` directory
+- The current directory contains a file with the `.hx` or `.hxml` 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` |
+| `detect_extensions` | `["hx", "hxml"]` | Which extensions should trigger this module. |
+| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Which folders should trigger this modules. |
+| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. |
+| `style` | `"bold fg:202"` | The style for the module. |
+| `disabled` | `false` | Disables the `haxe` module. |
+
+### Variables
+
+| Variable | Example | Description |
+| -------- | -------- | ------------------------------------ |
+| version | `v4.2.5` | The version of `haxe` |
+| 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
+
+[haxe]
+format = "via [⌘ $version](bold fg:202) "
+```
+
## Helm
The `helm` module shows the currently installed version of [Helm](https://helm.sh/).
@@ -2008,7 +2050,7 @@ The `hostname` module shows the system hostname.
| Option | Default | Description |
| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `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 |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
| `style` | `'bold dimmed green'` | The style for the module. |
@@ -2020,7 +2062,7 @@ The `hostname` module shows the system hostname.
| ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` |
-| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |
+| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string
@@ -2053,7 +2095,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Which extensions should trigger this module. |
| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | Which filenames should trigger this module. |
| `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'` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
@@ -2397,7 +2439,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `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 Lua. |
+| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. |
| `detect_extensions` | `['lua']` | Which extensions should trigger this module. |
| `detect_files` | `['.lua-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['lua']` | Which folders should trigger this module. |
@@ -2443,7 +2485,7 @@ To enable it, set `disabled` to `false` in your configuration file.
| ----------- | ---------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | The format for the module. |
-| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |
+| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |
| `style` | `'bold dimmed white'` | The style for the module. |
| `disabled` | `true` | Disables the `memory_usage` module. |
@@ -2455,7 +2497,7 @@ To enable it, set `disabled` to `false` in your configuration file.
| ram_pct | `48%` | The percentage of the current system memory. |
| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. |
| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. |
-| symbol | `🐏` | Mirrors the value of option `symbol` |
+| 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
@@ -2495,7 +2537,7 @@ By default the Meson project name is displayed, if `$MESON_DEVENV` is set.
| Variable | Example | Description |
| -------- | ---------- | ------------------------------------ |
| project | `starship` | The current Meson project name |
-| symbol | `🐏` | Mirrors the value of option `symbol` |
+| 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
@@ -2564,7 +2606,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 Nim. |
+| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. |
| `detect_files` | `['nim.cfg']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -2601,7 +2643,7 @@ The module will be shown when inside a nix-shell environment.
| Option | Default | Description |
| ------------ | -------------------------------------------- | ----------------------------------------------------- |
| `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. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
@@ -2693,7 +2735,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string 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 OCaml. |
+| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. |
| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. |
| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. |
| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Which extensions should trigger this module. |
@@ -2734,7 +2776,7 @@ By default the module will be shown if the current directory contains a `.rego`
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 OPA. |
+| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. |
| `detect_extensions` | `['rego']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -2772,7 +2814,7 @@ to fetch the current project in use.
| Option | Default | Description |
| ---------- | --------------------------------------------- | -------------------------------------------------------------- |
| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | The format for the module. |
-| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `openstack` module. |
@@ -2875,7 +2917,7 @@ Windows = "🪟 "
| Variable | Example | Description |
| -------- | ------------ | ------------------------------------------------------------------ |
-| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |
+| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |
| name | `Arch Linux` | The current operating system name |
| type | `Arch` | The current operating system type |
| codename | | The current operating system codename, if applicable |
@@ -2935,7 +2977,7 @@ package, and shows its current version. The module currently supports `npm`, `ni
| Option | Default | Description |
| ----------------- | --------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | The format for the module. |
-| `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
+| `symbol` | `'📦 '` | The symbol used before displaying the version the package. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold 208'` | The style for the module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
@@ -2977,7 +3019,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | The format string 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 Perl |
+| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl |
| `detect_extensions` | `['pl', 'pm', 'pod']` | Which extensions should trigger this module. |
| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -3016,7 +3058,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 PHP. |
+| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. |
| `detect_extensions` | `['php']` | Which extensions should trigger this module. |
| `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -3167,7 +3209,7 @@ By default the module will be shown if any of the following conditions are met:
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($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 Python |
+| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
| `style` | `'yellow bold'` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
@@ -3200,7 +3242,7 @@ Python version 2, see example below.
| Variable | Example | Description |
| ------------ | --------------- | ------------------------------------------ |
| version | `'v3.8.1'` | The version of `python` |
-| symbol | `'🐍 '` | Mirrors the value of option `symbol` |
+| symbol | `'🐍 '` | Mirrors the value of option `symbol` |
| style | `'yellow bold'` | Mirrors the value of option `style` |
| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` |
| virtualenv | `'venv'` | The current `virtualenv` name |
@@ -3261,7 +3303,7 @@ any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 R. |
+| `symbol` | `'📐'` | A format string representing the symbol of R. |
| `style` | `'blue bold'` | The style for the module. |
| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Which extensions should trigger this module |
| `detect_files` | `['.Rprofile']` | Which filenames should trigger this module |
@@ -3299,7 +3341,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string 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 Raku |
+| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Which extensions should trigger this module. |
| `detect_files` | `['META6.json']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -3337,7 +3379,7 @@ The module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 Red. |
+| `symbol` | `'🔺 '` | A format string representing the symbol of Red. |
| `detect_extensions` | `['red']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -3381,7 +3423,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 Ruby. |
+| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `['rb']` | Which extensions should trigger this module. |
| `detect_files` | `['Gemfile', '.ruby-version']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -3422,7 +3464,7 @@ The module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 Rust |
+| `symbol` | `'🦀 '` | A format string representing the symbol of Rust |
| `detect_extensions` | `['rs']` | Which extensions should trigger this module. |
| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -3554,7 +3596,7 @@ set to a number and meets or exceeds the specified threshold.
| ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Display threshold. |
| `format` | `'[$symbol$shlvl]($style) '` | The format for the module. |
-| `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. |
| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `true` | Disables the `shlvl` module. |
@@ -3664,12 +3706,12 @@ To enable it, set `disabled` to `false` in your configuration file.
| Option | Default | Description |
| --------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'[$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 |
-| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
-| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |
-| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |
-| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |
+| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
+| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |
+| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |
+| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |
| `style` | `'bold red'` | The style for the module. |
| `recognize_signal_code` | `true` | Enable signal mapping from exit code |
| `map_symbol` | `false` | Enable symbols mapping from exit code |
@@ -3727,7 +3769,7 @@ To enable it, set `disabled` to `false` in your configuration file.
| Option | Default | Description |
| --------------- | ------------------------ | ------------------------------------------------------- |
| `format` | `'[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'` | The style for the module. |
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Disables the `sudo` module. |
@@ -3775,7 +3817,7 @@ The module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `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 Swift |
+| `symbol` | `'🐦 '` | A format string representing the symbol of Swift |
| `detect_extensions` | `['swift']` | Which extensions should trigger this module. |
| `detect_files` | `['Package.swift']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
@@ -3823,7 +3865,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `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']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md
index 397975e63..a03344d8e 100644
--- a/docs/de-DE/README.md
+++ b/docs/de-DE/README.md
@@ -4,21 +4,21 @@ heroImage: /logo.svg
heroText:
tagline: Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!
actionText: Loslegen →
-actionLink: ./guide/
+actionLink: ./de-DE/guide/
features:
-
title: Kompatibel
details: Läuft mit den beliebtesten Shells auf den beliebtesten Betriebssystemen. Überall einsetzbar!
-
title: Rust-Powered
- details: Bringt die Schnelligkeit und Zuverlässigkeit von Rust in deine Shell-Prompt.
+ details: Bringt die Schnelligkeit und Sicherheit von Rust in deine Shell-Prompt.
-
title: Individualisierbar
details: Jedes noch so kleine Detail kann nach Deinen Wünschen angepasst werden, um die Eingabeaufforderung so minimal oder funktionsreich zu gestalten, wie Du es möchtest.
footer: ICS lizenziert | Copyright © 2019-heute Starship-Mitwirkende
#Used for the description meta tag, for SEO
metaTitle: "Starship: Cross-Shell Prompt"
-description: Starship ist eine minimale, super schnelle, und extrem anpassbare Prompt für jede Shell! Sie zeigt die Information, die man benötigt an, während sie schnell und minimal bleibt. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.
+description: Starship ist eine minimale, super schnelle, und extrem anpassbare Prompt für jede Shell! Sie zeigt die Information, die man benötigt an, während sie schnell und minimal bleibt. Schnell-Installation verfügbar für Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, und PowerShell.
---
Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Variable | Beispiel | Beschreibung |
| --------- | --------------------- | ------------------------------------ |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Spiegelt den Wert der Option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Spiegelt den Wert der Option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Variable | Beispiel | Beschreibung |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Spiegelt den Wert der Option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Spiegelt den Wert der Option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -271,7 +270,7 @@ Konfigurieren deine Shell um Starship zu initialisieren. Wähle dafür deine She
Bash
-Füge dies ans Ende von `~/.bashrc`:
+Trage folgendes am Ende der `~/.bashrc` ein:
```sh
eval "$(starship init bash)"
@@ -282,7 +281,7 @@ eval "$(starship init bash)"
⌘ Cmd
-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 musst [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) mit Cmd verwenden. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
```lua
load(io.popen('starship init cmd'):read("*a"))()
@@ -335,7 +334,7 @@ mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
```
-And add the following to the end of your Nushell configuration (find it by running `$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`):
```sh
source ~/.cache/starship/init.nu
@@ -381,7 +380,7 @@ execx($(starship init xonsh))
Zsh
-Füge dies ans Ende von `~/.zshrc`:
+Trage folgendes am Ende der `~/.zshrc` ein:
```sh
eval "$(starship init zsh)"
@@ -417,11 +416,19 @@ Checkt bitte diese älteren Projekte, die das Entstehen von Starhip inspiriert h
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
-
+
Unter der [ISC](https://github.com/starship/starship/blob/master/LICENSE) Lizens.
+Copyright © 2019-heute [Starship-Mitwirkende](https://github.com/starship/starship/graphs/contributors).
Dieses Projekt ist [ISC](https://github.com/starship/starship/blob/master/LICENSE) lizenziert.
diff --git a/docs/de-DE/installing/README.md b/docs/de-DE/installing/README.md
index 351a651b0..cdf0ac484 100644
--- a/docs/de-DE/installing/README.md
+++ b/docs/de-DE/installing/README.md
@@ -2,18 +2,18 @@
Um Starship zu installieren, musst du zwei Dinge tun:
-1. Holen Sie sich das **starship** Binary auf Ihren Computer
-1. Sagen Sie ihrer Shell, dass sie das Starship-Binary als Prompt benutzt, indem sie die Initialisierungs-Skripte ändern
+1. Lade die **starship** Datei auf den Computer herunter
+1. Weise deine Shell an die Starship Datei als Eingabeaufforderung zu nutzen, indem du eines der Initialisierungs-Skripte benutzt
-Die Anweisungen auf [der Hauptseite](/guide/#🚀-installation) werden für die meisten Benutzer gut funktionieren. Für einige speziellere Plattformen werden jedoch andere Anweisungen benötigt.
+Die Anleitung auf [der Hauptseite](/guide/#🚀-installation) wird für die meisten Benutzer ausreichend sein. Für einige speziellere Plattformen wird jedoch eine speziellere Anleitung benötigt.
-Es gibt so viele Plattformen, dass sie nicht in das Haupt-README passen, also hier einige Installationsanweisungen für andere Plattformen von der Community. Ist Ihre nicht hier? Bitte fügen Sie es hier hinzu, wenn Sie es herausfinden!
+Es gibt sehr viele Plattformen, sodass diese nicht alle in die Hauptanleitung passen, aus diesem Grund sind hier ein paar Installationsanweisungen für ein paar Plattformen von der Community. Ist deine Platform nicht dabei? Dann füge bitte deine hinzu, sobald du herausgefunden hast wie man starship mit dieser benutzt!
## [Chocolatey](https://chocolatey.org)
### Voraussetzungen
-Gehen Sie zur [Chocolatey's Installations-Seite](https://chocolatey.org/install) und folge den Anweisungen um Chocolatey zu installieren.
+Gehe zur [Chocolatey's Installations-Seite](https://chocolatey.org/install) und folge den Anweisungen um Chocolatey zu installieren.
### Installation
@@ -39,7 +39,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term
### 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:
+Unter Funtoo Linux kann starship von [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) über Portage installiert werden:
```sh
emerge app-shells/starship
@@ -57,13 +57,13 @@ nix-env -iA nixos.starship
#### Deklarativ, Einzel-Benutzer, über [home-manager](https://github.com/nix-community/home-manager)
-Aktivieren Sie das Modul `programs.starship` in Ihrer `home.nix`-Datei und fügen Sie Ihre Einstellungen hinzu
+Aktiviere das Modul `programs.starship` in deiner `home.nix`-Datei und füge deine Einstellungen hinzu
```nix
{
programs.starship = {
enable = true;
- # Configuration written to ~/.config/starship.toml
+ # Konfiguration die nach ~/.config/starship.toml geschrieben wird
settings = {
# add_newline = false;
@@ -78,7 +78,7 @@ Aktivieren Sie das Modul `programs.starship` in Ihrer `home.nix`-Datei und füge
}
```
-und führen Sie dann folgendes aus
+führe danach folgendes aus
```sh
home-manager switch
@@ -86,7 +86,7 @@ home-manager switch
#### Deklarativ, systemweit, mit NixOS
-Fügen Sie `pkgs.starship` zu `environment.systemPackages` in Ihrer `configuration.nix` hinzu, und führen Sie folgendes aus
+Füge `pkgs.starship` zu der Sektion `environment.systemPackages` in deiner `configuration.nix` hinzu, und führe folgenden Befehl aus
```sh
sudo nixos-rebuild switch
diff --git a/docs/de-DE/presets/README.md b/docs/de-DE/presets/README.md
index 6933f9747..5bea36f07 100644
--- a/docs/de-DE/presets/README.md
+++ b/docs/de-DE/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,14 +36,26 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
-This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
+Diese Voreinstellung emuliert das Aussehen und das Verhalten von [Pure](https://github.com/sindresorhus/pure).
-[](./pure-preset)
+[](./pure-preset)
## [Pastel Powerline](./pastel-powerline.md)
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/de-DE/presets/bracketed-segments.md b/docs/de-DE/presets/bracketed-segments.md
index 26e3980e8..453aaf0f7 100644
--- a/docs/de-DE/presets/bracketed-segments.md
+++ b/docs/de-DE/presets/bracketed-segments.md
@@ -1,4 +1,4 @@
-[Return to Presets](./README.md#bracketed-segments)
+[Zurück zu den Voreinstellungen](./README.md#bracketed-segments)
# Bracketed Segments Preset
@@ -12,6 +12,6 @@ This preset changes the format of all the built-in modules to show their segment
starship preset bracketed-segments > ~/.config/starship.toml
```
-[Click to download TOML](/presets/toml/bracketed-segments.toml)
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml
diff --git a/docs/de-DE/presets/nerd-font.md b/docs/de-DE/presets/nerd-font.md
index 8cf6c3609..e291ebf70 100644
--- a/docs/de-DE/presets/nerd-font.md
+++ b/docs/de-DE/presets/nerd-font.md
@@ -1,4 +1,4 @@
-[Return to Presets](./README.md#nerd-font-symbols)
+[Zurück zu den Voreinstellungen](./README.md#nerd-font-symbols)
# Nerd Font Symbols Preset
@@ -16,6 +16,6 @@ This preset changes the symbols for each module to use Nerd Font symbols.
starship preset nerd-font-symbols > ~/.config/starship.toml
```
-[Click to download TOML](/presets/toml/nerd-font-symbols.toml)
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/nerd-font-symbols.toml)
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml
diff --git a/docs/de-DE/presets/no-empty-icons.md b/docs/de-DE/presets/no-empty-icons.md
new file mode 100644
index 000000000..5244f41d0
--- /dev/null
+++ b/docs/de-DE/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Zurück zu den Voreinstellungen](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Konfiguration
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/de-DE/presets/no-nerd-font.md b/docs/de-DE/presets/no-nerd-font.md
new file mode 100644
index 000000000..69c7dfbe3
--- /dev/null
+++ b/docs/de-DE/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Zurück zu den Voreinstellungen](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Konfiguration
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/de-DE/presets/no-runtimes.md b/docs/de-DE/presets/no-runtimes.md
index d18faeae3..2f359d758 100644
--- a/docs/de-DE/presets/no-runtimes.md
+++ b/docs/de-DE/presets/no-runtimes.md
@@ -1,4 +1,4 @@
-[Return to Presets](./README.md#no-runtime-versions)
+[Zurück zu den Voreinstellungen](./README.md#no-runtime-versions)
# No Runtime Versions Preset
@@ -12,6 +12,6 @@ This preset hides the version of language runtimes. If you work in containers or
starship preset no-runtime-versions > ~/.config/starship.toml
```
-[Click to download TOML](/presets/toml/no-runtime-versions.toml)
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/no-runtime-versions.toml)
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml
diff --git a/docs/de-DE/presets/pastel-powerline.md b/docs/de-DE/presets/pastel-powerline.md
index 21e0ae322..39297f4db 100644
--- a/docs/de-DE/presets/pastel-powerline.md
+++ b/docs/de-DE/presets/pastel-powerline.md
@@ -1,4 +1,4 @@
-[Return to Presets](./README.md#pastel-powerline)
+[Zurück zu den Voreinstellungen](./README.md#pastel-powerline)
# Pastel Powerline Preset
@@ -16,6 +16,6 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
starship preset pastel-powerline > ~/.config/starship.toml
```
-[Click to download TOML](/presets/toml/pastel-powerline.toml)
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml
diff --git a/docs/de-DE/presets/plain-text.md b/docs/de-DE/presets/plain-text.md
index 09f07c1bd..fdcc1f717 100644
--- a/docs/de-DE/presets/plain-text.md
+++ b/docs/de-DE/presets/plain-text.md
@@ -1,4 +1,4 @@
-[Return to Presets](./README.md#plain-text-symbols)
+[Zurück zu den Voreinstellungen](./README.md#plain-text-symbols)
## Plain Text Symbols Preset
@@ -12,6 +12,6 @@ This preset changes the symbols for each module into plain text. Great if you do
starship preset plain-text-symbols > ~/.config/starship.toml
```
-[Click to download TOML](/presets/toml/plain-text-symbols.toml)
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/plain-text-symbols.toml)
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml
diff --git a/docs/de-DE/presets/pure-preset.md b/docs/de-DE/presets/pure-preset.md
index 0c30bee5b..2f2384592 100644
--- a/docs/de-DE/presets/pure-preset.md
+++ b/docs/de-DE/presets/pure-preset.md
@@ -1,10 +1,10 @@
-[Return to Presets](./README.md#pure)
+[Zurück zu den Voreinstellungen](./README.md#pure)
-# Pure Preset
+# Pure Voreinstellung
-This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
+Diese Voreinstellung emuliert das Aussehen und das Verhalten von [Pure](https://github.com/sindresorhus/pure).
-
+
### Konfiguration
@@ -12,6 +12,6 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
starship preset pure-preset > ~/.config/starship.toml
```
-[Click to download TOML](/presets/toml/pure-preset.toml)
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml
diff --git a/docs/de-DE/presets/tokyo-night.md b/docs/de-DE/presets/tokyo-night.md
new file mode 100644
index 000000000..9fd57a104
--- /dev/null
+++ b/docs/de-DE/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Zurück zu den Voreinstellungen](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Voraussetzungen
+
+- Eine [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in deinem Terminal
+
+### Konfiguration
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Zum Herunterladen der TOML Datei klicken](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md
index 1bb1a86ee..0a100eb51 100644
--- a/docs/es-ES/advanced-config/README.md
+++ b/docs/es-ES/advanced-config/README.md
@@ -205,7 +205,9 @@ Algunos intérpretes de comandos soportan un prompt derecho que se renderiza en
Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. Para alinear los módulos arriba de la línea de entrada en un prompt multi-línea, vea el [módulo `fill`](/config/#fill).
-`right_format` está actualmente soportado para los siguientes intérpretes de comandos: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ Si se especifican varios colores para el primer plano/fondo, el último en la ca
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md
index cbac49832..65d08938b 100644
--- a/docs/es-ES/config/README.md
+++ b/docs/es-ES/config/README.md
@@ -9,21 +9,23 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Toda la configuración de starship se incluye en este fichero [TOML](https://github.com/toml-lang/toml):
```toml
-# Obtiene las completaciones del editor basadas en el esquema de configuración
+# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'
-# Inserta una línea en blanco entre los prompts del intérprete de comandos
+# Inserts a blank line between shell prompts
add_newline = true
-# Reemplaza el símbolo "❯" en el prompt por "➜"
-[character] # El nombre del módulo que estamos configurando es "character"
-success_symbol = "[➜](bold green)" # El segmento "success_symbol" se está oonfigurando es "➜" con el color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
-# Deshabilita el módulo "package", ocultándolo del prompt completamente
+# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
Puedes cambiar la ubicación por defecto del archivo de configuración con la variable de entorno `STARSHIP_CONFIG`:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Por convención, la mayoría de los módulos tienen un prefijo del color predeterminado de la terminal (por ejemplo, `vía` en "nodejs") y un espacio vacío como sufijo.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+Por ejemplo:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Cadenas de Formato
Es el formato con el que un módulo imprime todas sus variables. La mayoría de los módulos tienen una entrada llamada `format` que configura el formato de visualización del módulo. Se puede utilizar textos, variables y grupos de texto.
@@ -80,36 +138,36 @@ Una variable contiene un símbolo `$` seguido por el nombre de la variable. El n
Por ejemplo:
-- `$version` es una cadena de formato con una variable llamada `version`.
-- `$git_branch$git_commit` es un formato de cadena de texto con dos variables nombradas `git_branch` y `git_commit`.
-- `$git_branch $git_commit` tiene las dos variables separadas por un espacio.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Grupo de Texto
Un grupo de texto se compone de dos partes diferentes.
-La primera parte, que está encerrada en un `[]`, es un [formato de cadena de texto](#format-strings). Se puede agregar textos, variables, o incluso grupos de texto anidados.
+La primera parte, que está encerrada en un `[]`, es una [cadena de formato](#format-strings). Se puede agregar textos, variables, o incluso grupos de texto anidados.
-En la segunda parte, que está encerrada en un `()`, es un [formato de cadena de texto](#style-strings). Esto se puede utilizar para diseñar la primera parte.
+En la segunda parte, que está encerrada entre `()`, es una [cadena de estilo](#style-strings). Esto se puede utilizar para diseñar la primera parte.
Por ejemplo:
-- `[en](bold red)` imprimirá una cadena `en` con texto en negrita color rojo.
-- `[⌘ $version](bold green)` imprimirá un símbolo `⌘` seguido por el contenido de la variable `version`, con texto en negrita color verde.
-- `[a [b](red) c](green)` imprimirá `a b c` con `b` en rojo, `a` y `c` en verde.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Cadenas de Estilo
-La mayoría de los módulos de starship permiten configurar los estilos de su cadenas texto. Esto se consigue con una entrada (normalmente llamada `style` - estilo) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de textos estilados junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consulta [la guía de configuración avanzada](/advanced-config/).
+La mayoría de los módulos de starship permiten configurar sus estilos de visualización. Esto se consigue con una entrada (normalmente llamada `style`) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de cadenas de estilo junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consultar [la guía de configuración avanzada](/advanced-config/).
-- `"fg:green bg:blue"` pone texto verde sobre un fondo azul
-- `"bg:blue fg:bright-green"` pone texto verde claro sobre un fondo azul
-- `"bold fg:27"` pone texto en negrita con [color ANSI](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` subraya el texto sobre un fondo naranja oscuro
-- `"bold italic fg:purple"` pone texto color morado, en negrita y cursiva
-- `""` desactiva explícitamente cualquier estilo
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
-Nótese que el estilo es similar a como se controlaría por el emulador de su terminal. Por ejemplo, algunos emuladores de terminal harán los colores más brillantes en lugar de más gruesos, y algunos temas usan los mismos valores para texto normal y colores brillantes. Además, para mostrar textos en cursiva tu terminal debe tener soporte para hacerlo.
+Nótese que el estilo es similar a como se controlaría por el emulador de terminal. Por ejemplo, algunos emuladores de terminal harán los colores más brillantes en lugar de más gruesos, y algunos temas de colores usan los mismos valores para texto normal y colores brillantes. Además, para mostrar textos en cursiva tu terminal debe tener soporte para hacerlo.
#### Cadenas de Formato Condicional
@@ -117,96 +175,72 @@ Una cadena de formato condicional envuelto en `(` y `)` no se renderizará si to
Por ejemplo:
-- `(@$region)` no mostrará nada si la variable `region` es `None` o una cadena vacía, de lo contrario `@` seguido por el valor de la región.
-- `(algún texto)` siempre mostrará nada ya que no hay variables envueltas entre llaves.
-- Cuando `$all` es un atajo para `\[$a$b\]`, `($all)` no mostrará nada solo si `$a` y `$b` ambos son `None`. Esto funciona igual que `(\[$a$b\] )`.
-
-#### Caracteres especiales
-
-Los siguientes símbolos tienen un uso especial en una cadena de formato y deben ser escapados: `$ \ [ ] ( )`.
-
-Ten en cuenta que TOML tiene [cadenas de caracteres básicas y cadenas de caracteres literales](https://toml.io/en/v1.0.0#string). Se recomienda usar una cadena de caracteres literal (rodeada de comillas simples) en tu configuración. Si quieres utilizar una cadena de caracteres básica (rodeada de comillas dobles), debes escapar la barra inversa, en sí misma (es decir, utilizar `\\`).
-
-Por ejemplo, cuando se desea imprimir un símbolo `$` en una nueva línea, las siguientes configuraciones para el `format` son equivalentes:
-
-```toml
-# con cadena básica
-format = "\n\\$"
-
-# con cadena básica multilínea
-format = """
-
-\\$"""
-
-# con cadena literal
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Coincidencia negativa
-Varios módulos tienen variables `detect_extensions`, `detect_files`y `detect_folders`. Estas toman listas de cadenas de texto para que coincidan o no coincidan. Las opciones "negativas", aquellas que no deben coincidir, están indicadas con un carácter "!" al inicio. La presencia de _cualquier_ indicador negativo en el directorio hará que el módulo no coincida.
+Varios módulos tienen variables `detect_extensions`, `detect_files`y `detect_folders`. Estas toman listas de cadenas de texto para que coincidan o no coincidan. "Negative" options, those which should not be matched, are indicated with a leading '!' character. La presencia de _cualquier_ indicador negativo en el directorio hará que el módulo no coincida.
Las extensiones coinciden tanto con los caracteres después del último punto en un nombre de archivo, como con los caracteres después del primer punto en un nombre de archivo. Por ejemplo, `foo.bar.tar.gz` será emparejado contra `bar.tar.gz` y `gz` en la variable `detect_extensions`. Los archivos cuyo nombre comienza con un punto no se consideran extensiones en absoluto.
Para ver cómo funciona esto en la práctica, puede hacer coincidir con archivos TypeScript, pero no con archivos MPEG Transport Stream, así:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
-Esta es la lista de opciones de configuración.
+Esta es la lista de opciones de configuración del prompt.
### Opciones
-| Opción | Predeterminado | Descripción |
-| ----------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `format` | [link](#default-prompt-format) | Configura el formato del prompt. |
-| `right_format` | `""` | Ver [Habilitar prompt derecho](/advanced-config/#enable-right-prompt) |
-| `scan_timeout` | `30` | Tiempo de espera tras el que starship escanea archivos (en milisegundos). |
-| `command_timeout` | `500` | Tiempo de espera para los comandos ejecutados por starship (en milisegundos). |
-| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. |
-| `paleta` | `""` | Establece la paleta de color de `paletas` a utilizar. |
-| `paletas` | `{}` | Colección de paletas de colores que asignan [colores](/advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. |
+| Opción | Por defecto | Descripción |
+| ----------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. |
+| `right_format` | `''` | Ver [Habilitar prompt derecho](/advanced-config/#enable-right-prompt) |
+| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea archivos (en milisegundos). |
+| `command_timeout` | `500` | Tiempo de espera para los comandos ejecutados por Starship (en milisegundos). |
+| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. |
+| `paleta` | `''` | Establece la paleta de color de `paletas` a utilizar. |
+| `paletas` | `{}` | Colección de paletas de colores que asignan [colores](/advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. |
### Ejemplo
```toml
# ~/.config/starship.toml
-# Usar formato personalizado
-format = """
+# Use custom format
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
-# Espera 10 milisegundos para que starship revise los archivos del directorio actual.
+# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Establece "foo" como paleta de color personalizado
-as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
-# Definir colores personalizados
+# Define custom colors
[palettes.foo]
-# Sobreescribir actual color
-blue = "21"
-# Definir nuevo color
-mustard = "#af8700"
+# Overwrite existing color
+blue = '21'
+# Define new color
+mustard = '#af8700'
```
-### Formato predeterminado del Prompt
+### Formato por Defecto del Prompt
-El `format` predeterminado se utiliza para definir el formato del prompt, si está vacío o no `format` se proporciona. El valor por defecto es el siguiente:
+La varieble `format` por defecto se utiliza para definir el formato del prompt, si está vacía o `format` no se proporciona. El valor predeterminado es el siguiente:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -237,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -246,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -282,16 +319,17 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
```
-Si solo quieres extender el formato predeterminado, puedes usar `$all`; los módulos que se añaden explícitamente al formato no serán duplicados. Por ejemplo.
+Si solo quieres extender el formato predeterminado, puedes usar `$all`; los módulos que se añaden explícitamente al formato no serán duplicados. Ej.
```toml
-# Mueve el módulo directorio a la segunda línea
-format="$all$directory$character"
+# Move the directory to the second line
+format = '$all$directory$character'
```
## AWS
@@ -300,21 +338,23 @@ El módulo `aws` muestra la región y el perfil actual de AWS y un temporizador
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
-Cuando se utiliza [aws-vault](https://github.com/99designs/aws-vault), el perfil se lee de la variable de entorno `AWS_VAULT` y la fecha de expiración de credenciales se lee de la variable de entorno `AWS_SESSION_EXPIRATION`.
+Cuando se utiliza [aws-vault](https://github.com/99designs/aws-vault), el perfil se obtiene de la variable de entorno `AWS_VAULT` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWS_SESSION_EXPIRATION`.
-Cuando uses [awsu](https://github.com/kreuzwerker/awsu) el perfil se obtiene de la variable de entorno `AWSU_PROFILE`.
+Cuando se utiliza [awsu](https://github.com/kreuzwerker/awsu) el perfil se lee de la variable de entorno `AWSU_PROFILE`.
-Cuando se utiliza [AWSume](https://awsu.me), el perfil se lee de la variable de entorno `AWSUME_PROFILE` y la fecha de expiración de credenciales se lee de la variable de entorno `AWSUME_EXPIRATION`.
+Cuando se utiliza [AWSume](https://awsu.me), el perfil se obtiene de la variable de entorno `AWSUME_PROFILE` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWSUME_EXPIRATION`.
+
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
### Opciones
| Opción | Por defecto | Descripción |
| ------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | El formato del módulo. |
-| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. |
-| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
-| `profile_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
-| `style` | `"bold yellow"` | El estilo del módulo. |
+| `symbol` | `'☁️ '` | El símbolo que se muestra antes del perfil de AWS. |
+| `region_aliases` | `{}` | Tabla de alias de región para mostrar además del nombre AWS. |
+| `profile_aliases` | `{}` | Tabla de alias de región para mostrar además del nombre AWS. |
+| `style` | `'bold yellow'` | El estilo del módulo. |
| `expiration_symbol` | `X` | El símbolo mostrado cuando las credenciales temporales han caducado. |
| `disabled` | `false` | Desactiva el módulo AWS. |
| `force_display` | `false` | Si `true` muestra información incluso si `credentials`, `credential_process` o `sso_start_url` no han sido configuradas. |
@@ -340,11 +380,11 @@ Cuando se utiliza [AWSume](https://awsu.me), el perfil se lee de la variable de
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -355,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Mostrar perfil
@@ -369,53 +409,67 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-El módulo `azure` muestra la suscripción Azure actual. Esto consiste en mostrar el nombre de la suscripción predeterminada, como se define en el archivo `~/.azure/azureProfile.json`.
+El módulo `azure` muestra la suscripción Azure actual. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Opciones
| Variable | Por defecto | Descripción |
| ---------- | ---------------------------------------- | ------------------------------------------- |
-| `format` | `"on [$symbol($subscription)]($style) "` | El formato para renderizar el módulo Azure. |
-| `symbol` | `"ﴃ "` | El símbolo utilizado en el formato. |
-| `style` | `"blue bold"` | El estilo utilizado en el formato. |
+| `format` | `'on [$symbol($subscription)]($style) '` | El formato para renderizar el módulo Azure. |
+| `symbol` | `'ﴃ '` | El símbolo utilizado en el formato. |
+| `style` | `'blue bold'` | El estilo utilizado en el formato. |
| `disabled` | `true` | Deshabilita el módulo `azure`. |
-### Ejemplo
+### Ejemplos
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
## Battery
-El módulo `battery` muestra la cantidad de batería y si está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%.
+El módulo `battery` muestra la cantidad de batería y si se está cargando o no. El módulo solamente es visible cuando la batería del dispositivo está por debajo del 10%.
### Opciones
| Opción | Por defecto | Descripción |
| -------------------- | --------------------------------- | ------------------------------------------------------------------------ |
-| `full_symbol` | `" "` | Se muestra cuando la batería está cargada. |
-| `charging_symbol` | `" "` | Se muestra cuando la batería está cargando. |
-| `discharging_symbol` | `" "` | Se muestra cuando la batería se está descargando. |
-| `unknown_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería es desconocido. |
-| `empty_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería está vacío. |
-| `format` | `"[$symbol$percentage]($style) "` | El formato del módulo. |
-| `display` | [link](#battery-display) | Define cuándo mostrar el indicador y el estilo. |
+| `full_symbol` | `' '` | Se muestra cuando la batería está cargada. |
+| `charging_symbol` | `' '` | Se muestra cuando la batería se está cargando. |
+| `discharging_symbol` | `' '` | Se muestra cuando la batería se está descargando. |
+| `unknown_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería es desconocido. |
+| `empty_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería está vacío. |
+| `format` | `'[$symbol$percentage]($style) '` | El formato del módulo. |
+| `display` | [ver aquí](#battery-display) | Define cuándo mostrar el indicador y el estilo. |
| `disabled` | `false` | Desactiva el módulo `battery`. |
### Ejemplo
@@ -424,47 +478,47 @@ El módulo `battery` muestra la cantidad de batería y si está cargando o no. E
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Indicador de batería
-La opción de configuración `display` se utiliza para definir cuándo debe mostrarse el indicador de batería (threshold), qué symbol se utilizaría (symbol), y cómo sería (style). Si no se provee ningún valor para `display` El valor por defecto es el siguiente:
+La opción de configuración `display` se utiliza para definir cuándo debe mostrarse el indicador de batería (threshold), cuál símbolo se utilizaría (symbol), y cómo sería (style). Si no se provee ningún valor para `display`. El valor predeterminado es el siguiente:
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
-El valor por defecto para las opciones `charging_symbol` y `discharging_symbol` son respectivamente los valores `charging_symbol` y `discharging_symbol` de las opción de `battery`.
+El valor por defecto para las opciones `charging_symbol` y `discharging_symbol` son respectivamente los valores `charging_symbol` y `discharging_symbol` de las opciones de `battery`.
#### Opciones
-La opción `display` es un array de la siguiente tabla.
+La opción `display` es un arreglo de la siguiente tabla.
| Opción | Por defecto | Descripción |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | El umbral para la opción de visualización. |
-| `style` | `"red bold"` | El estilo usado cuando si la opción <0>display está activa. |
+| `style` | `'red bold'` | El estilo usado cuando si la opción <0>display está activa. |
| `charging_symbol` | | Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción `charging_symbol` de la batería. |
| `discharging_symbol` | | Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción `discharging_symbol` de la batería. |
#### Ejemplo
```toml
-[[battery.display]] # Estilo "rojo fuerte" y símbolo de descarga cuando la capacidad está entre 0% y 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # Estilo "amarillo fuerte" y símbolo 💦 cuando la capacidad está entre 10% y 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
-# cuando la capacidad está sobre el 30%, el indicador de batería no se visualizara
+# when capacity is over 30%, the battery indicator will not be displayed
```
## Buf
@@ -478,14 +532,14 @@ El módulo `buf` muestra la versión instalada de [Buf](https://buf.build). Por
| Opción | Por defecto | Descripción |
| ------------------- | ----------------------------------------------- | ---------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | El formato para el módulo `buf`. |
-| `version_format` | `"v${raw}"` | El formato de versión. |
-| `symbol` | `"🦬 "` | El símbolo usado antes de mostrar la versión de Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | El formato para el módulo `buf`. |
+| `version_format` | `'v${raw}'` | El formato de versión. |
+| `symbol` | `'🦬 '` | El símbolo usado antes de mostrar la versión de Buf. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Qué nombres de archivo deberían activar este módulo. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
-| `style` | `"bold blue"` | El estilo del módulo. |
-| `disabled` | `false` | Desactiva el módulo `elixir`. |
+| `style` | `'bold blue'` | El estilo del módulo. |
+| `disabled` | `false` | Deshabilita el módulo `elixir`. |
### Variables
@@ -503,7 +557,7 @@ El módulo `buf` muestra la versión instalada de [Buf](https://buf.build). Por
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -517,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🍞 "` | Una cadena de formato que representa el símbolo de Node.js. |
+| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Qué nombres de archivo deberían activar este módulo. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
-| `style` | `"bold red"` | El estilo del módulo. |
+| `style` | `'bold red'` | El estilo del módulo. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -542,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -553,14 +607,14 @@ El módulo `c` muestra información sobre su compilador de C. Por defecto el mó
| Opción | Por defecto | Descripción |
| ------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | La cadena de formato para el módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | El símbolo usado antes de mostrar los detalles del compilador |
-| `detect_extensions` | `["c", "h"]` | Qué extensiones deberían activar este módulo. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | La cadena de formato para el módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | El símbolo usado antes de mostrar los detalles del compilador |
+| `detect_extensions` | `['c', 'h']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | Cómo detectar cuál compilador es |
-| `style` | `"bold 149"` | El estilo del módulo. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | Cómo detectar cuál compilador es |
+| `style` | `'bold 149'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `c`. |
### Variables
@@ -578,7 +632,7 @@ NB que `versión` no está en el formato por defecto.
La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador.
-Cada comando se representa como una lista del nombre del ejecutable seguido de sus argumentos, generalmente algo como `["mycc", "--version"]`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT.
Si un compilador C no es compatible con este módulo, puede solicitarlo [planteando un problema en GitHub](https://github.com/starship/starship/).
@@ -588,14 +642,14 @@ Si un compilador C no es compatible con este módulo, puede solicitarlo [plantea
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
-El módulo `character` muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal.
+El módulo `character` muestra un carácter (normalmente una flecha) al lado del texto que introduces en la terminal.
-El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras:
+El caracter te dirá si el último comando fue exitoso o no. Se puede hacer de dos maneras:
- Cambiando el color (`red`/`green`)
- Cambiando la forma (`.`/`✖`)
@@ -612,13 +666,13 @@ Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [
| Opción | Por defecto | Descripción |
| --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. |
-| `success_symbol` | `"[❯](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. |
-| `error_symbol` | `"[❯](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | La cadena de formato usada antes de la entrada de texto. |
+| `success_symbol` | `'[❯](bold green)'` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. |
+| `error_symbol` | `'[❯](bold red)'` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Desactiva el módulo `character`. |
### Variables
@@ -635,8 +689,8 @@ Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Sin formato de error personalizado
@@ -645,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### Con formato de vim personalizado
@@ -655,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -669,14 +723,14 @@ El módulo `cmake` muestra la versión actualmente instalada de [CMake](https://
| Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"△ "` | El símbolo usado antes de la versión de cmake. |
+| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'△ '` | El símbolo usado antes de la versión de cmake. |
| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Qué nombres de archivo deben activar este módulo |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Qué nombres de archivo deben activar este módulo |
| `detect_folders` | `[]` | Qué carpetas deben activar este módulo |
-| `style` | `"bold blue"` | El estilo del módulo. |
-| `disabled` | `false` | Desactiva el módulo `cmake`. |
+| `style` | `'bold blue'` | El estilo del módulo. |
+| `disabled` | `false` | Deshabilita el módulo `cmake`. |
### Variables
@@ -699,11 +753,11 @@ El módulo `cobol` muestra la versión instalada de COBOL. Por defecto, el módu
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | El símbolo usado antes de mostrar la versión de COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | El estilo del módulo. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Qué extensiones deberían activar este módulo. |
+| `symbol` | `'⚙️ '` | El símbolo usado antes de mostrar la versión de COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | El estilo del módulo. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `disabled` | `false` | Deshabilita el módulo `cobol`. |
@@ -720,27 +774,27 @@ El módulo `cobol` muestra la versión instalada de COBOL. Por defecto, el módu
## Tiempo de ejecución
-El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time`, si existe.
+El módulo `cmd_duration` muestra cuánto tiempo tomó ejecutarse el último comando. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time` si existe.
-::: warning No utilizar DEBUG en Bash
+::: warning No utilizar la trampa DEBUG en Bash
-Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**.
+Si estás usando Starship con `Bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**.
:::
-Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre.
+Los usuarios de Bash que necesiten la funcionalidad como preexec pueden usar el [framework bash_preexec de rcaloras](https://github.com/rcaloras/bash-preexec). Basta con definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre.
### Opciones
| Opción | Por defecto | Descripción |
| ---------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `min_time` | `2_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos) |
-| `show_milliseconds` | `false` | Muestra la duración con precisión en milisegundos. |
-| `format` | `"took [$duration]($style) "` | El formato del módulo. |
-| `style` | `"bold yellow"` | El estilo del módulo. |
-| `disabled` | `false` | Desactiva el módulo `cmd_duration`. |
+| `min_time` | `2_000` | Duración más corta para mostrar el tiempo (en milisegundos). |
+| `show_milliseconds` | `false` | Mostrar milisegundos además de segundos para la duración. |
+| `format` | `'took [$duration]($style) '` | El formato del módulo. |
+| `style` | `'bold yellow'` | El estilo del módulo. |
+| `disabled` | `false` | Deshabilita el módulo `cmd_duration`. |
| `show_notifications` | `false` | Muestra notificaciones de escritorio cuando se complete el comando. |
-| `min_time_to_notify` | `45_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos). |
+| `min_time_to_notify` | `45_000` | Duración más corta para la notificación (en milisegundos). |
| `notification_timeout` | | Duración para mostrar la notificación (en milisegundos). Si no se establece, el tiempo de espera para notificar será determinado por el demonio. No todos los demonios de notificaciones honran esta opción. |
### Variables
@@ -759,7 +813,7 @@ Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -768,26 +822,26 @@ El módulo `conda` muestra el entorno actual [Conda](https://docs.conda.io/en/la
::: tip
-Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`.
+Esto no modifica el propio símbolo de sistema de Conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`.
:::
### Opciones
-| Opción | Por defecto | Descripción |
-| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `truncation_length` | `1` | El número de directorios a los que se debe truncar la variable de entorno, si el entorno fue creado usando `conda create -p [path]`. `0` significa sin truncamiento. Mirar también el módulo [`directory`](#directory). |
-| `symbol` | `"🅒 "` | El símbolo usado antes del nombre del entorno. |
-| `style` | `"bold green"` | El estilo del módulo. |
-| `format` | `"via [$symbol$environment]($style) "` | El formato del módulo. |
-| `ignore_base` | `true` | Ignora el entorno `base` cuando se activa. |
-| `disabled` | `false` | Desactiva el módulo `conda`. |
+| Opción | Por defecto | Descripción |
+| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `1` | El número de directorios a los que se debe truncar la ruta de entorno, si el entorno fue creado a través de `conda create -p [path]`. `0` significa sin truncamiento. Vea también el módulo [`directory`](#directory). |
+| `symbol` | `'🅒 '` | El símbolo usado antes del nombre del entorno. |
+| `style` | `'bold green'` | El estilo del módulo. |
+| `format` | `'via [$symbol$environment]($style) '` | El formato del módulo. |
+| `ignore_base` | `true` | Ignora el entorno `base` cuando se activa. |
+| `disabled` | `false` | Deshabilita el módulo `conda`. |
### Variables
| Variable | Ejemplo | Descripción |
| ----------- | ------------ | -------------------------------------- |
-| environment | `astronauts` | El entorno conda actual |
+| environment | `astronauts` | El entorno Conda actual |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
@@ -799,7 +853,7 @@ Esto no modifica el propio símbolo de sistema de conda. En caso de querer supri
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Contenedor
@@ -810,8 +864,8 @@ El módulo `container` muestra el símbolo y nombre del contenedor, si está den
| Opción | Por defecto | Descripción |
| ---------- | ---------------------------------- | ---------------------------------------------------------------- |
-| `symbol` | `"⬢"` | El símbolo mostrado, cuando se encuentra dentro de un contenedor |
-| `style` | `"bold red dimmed"` | El estilo del módulo. |
+| `symbol` | `'⬢'` | El símbolo mostrado, cuando se encuentra dentro de un contenedor |
+| `style` | `'bold red dimmed'` | El estilo del módulo. |
| `format` | `'[$symbol \[$name\]]($style) '` | El formato del módulo. |
| `disabled` | `false` | Deshabilita el módulo `container`. |
@@ -845,14 +899,14 @@ El módulo `cristal` muestra la versión instalada de [Crystal](https://crystal-
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | El estilo del módulo. |
-| `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. |
-| `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. |
+| `symbol` | `'🔮 '` | El símbolo usado antes de mostrar la versión del crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | El estilo del módulo. |
+| `detect_extensions` | `['cr']` | Qué extensiones deberían activar este módulo. |
+| `detect_files` | `['shard.yml']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
-| `disabled` | `false` | Desactiva el módulo `crystal`. |
+| `disabled` | `false` | Deshabilita el módulo `crystal`. |
### Variables
@@ -870,7 +924,7 @@ El módulo `cristal` muestra la versión instalada de [Crystal](https://crystal-
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -881,14 +935,14 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
### Opciones
-| Opción | Predeterminado | Descripción |
+| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
-| `style` | `"bold cyan"` | El estilo del módulo. |
+| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | El estilo del módulo. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
-| `detect_files` | `["daml.yaml"]` | Qué nombres de archivo deberían activar este módulo. |
+| `detect_files` | `['daml.yaml']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `disabled` | `false` | Deshabilita el módulo `daml`. |
@@ -908,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -921,16 +975,16 @@ El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Po
### Opciones
-| Opción | Predeterminado | Descripción |
+| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart |
-| `detect_extensions` | `["dart"]` | Qué extensiones deberían activar este módulo. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. |
-| `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. |
-| `style` | `"bold blue"` | El estilo del módulo. |
-| `disabled` | `false` | Desactiva el módulo `dart`. |
+| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | Una cadena de formato que representa el símbolo de Dart |
+| `detect_extensions` | `['dart']` | Qué extensiones deberían activar este módulo. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Qué nombres de archivo deberían activar este módulo. |
+| `detect_folders` | `['.dart_tool']` | Qué carpetas deberían activar este módulo. |
+| `style` | `'bold blue'` | El estilo del módulo. |
+| `disabled` | `false` | Deshabilita el módulo `dart`. |
### Variables
@@ -948,7 +1002,7 @@ El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Po
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -959,15 +1013,15 @@ El módulo `deno` le muestra la versión instalada de [Deno](https://deno.land/)
### Opciones
-| Opción | Predeterminado | Descripción |
+| Opción | Por defecto | Descripción |
| ------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
-| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🦕 "` | Una cadena de formato que representa el símbolo de Deno |
+| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
+| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🦕 '` | Una cadena de formato que representa el símbolo de Deno |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Qué nombres de archivo deberían activar este módulo. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
-| `style` | `"green bold"` | El estilo del módulo. |
+| `style` | `'green bold'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `deno`. |
### Variables
@@ -984,49 +1038,50 @@ El módulo `deno` le muestra la versión instalada de [Deno](https://deno.land/)
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
-El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés.
+El módulo `directory` muestra la ruta a tu directorio actual, truncado a tres carpetas padres. Tu directorio se truncará a la raíz del repositorio git en el que te encuentres.
-Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activa la opción.
+Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activaste para la opción.
-Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y el valor de la opción es `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`.
+Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y la opción establecida a `1`. Ahora verás `~/D/N/nixpkgs/pkgs`, mientras que antes habría sido `nixpkgs/pkgs`.
### Opciones
-| Opción | Predeterminado | Descripción |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | El número de directorios padre a los que se debe truncar el directorio actual. |
-| `truncate_to_repo` | `true` | Trunca o no hasta la raíz del repositorio git en el que estés. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | El formato del módulo. |
-| `style` | `"bold cyan"` | El estilo del módulo. |
-| `disabled` | `false` | Desactiva el módulo `directory`. |
-| `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. |
-| `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. |
-| `truncation_symbol` | `""` | El símbolo a prefijar a las rutas truncadas. ej: "…/" |
-| `repo_root_style` | | El estilo para la raíz del repositorio de git. El valor por defecto es equivalente al `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | El formato de un repositorio de git cuando `repo_root_style` está definido. |
-| `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
-| `use_os_path_sep` | `true` | Utiliza el separador de ruta del sistema operativo específico en lugar de usar siempre `/` (por ejemplo, `\` en Windows) |
+| Opción | Por defecto | Descripción |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | El número de carpetas a las que se debe truncar el directorio actual. |
+| `truncate_to_repo` | `true` | Truncar o no hasta la raíz del repositorio git en el que se esté. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | El formato del módulo. |
+| `style` | `'bold cyan'` | El estilo del módulo. |
+| `disabled` | `false` | Deshabilita el módulo `directory`. |
+| `read_only` | `'🔒'` | El símbolo que indica el directorio actual es de sólo lectura. |
+| `read_only_style` | `'red'` | El estilo para el símbolo de sólo lectura. |
+| `truncation_symbol` | `''` | El símbolo a prefijar a las rutas truncadas. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. El valor por defecto es equivalente al `style`. |
+| `repo_root_style` | | El estilo para la raíz del repositorio de git. El valor por defecto es equivalente al `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | El símbolo que indica el directorio de inicio. |
+| `use_os_path_sep` | `true` | Utiliza el separador de ruta del sistema operativo específico en lugar de usar siempre `/` (por ejemplo, `\` en Windows) |
Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.
-| Opciones avanzadas | Predeterminado | Descripción |
-| --------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. |
-| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd de la shell de fish. |
-| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. |
+| Opción avanzada | Por defecto | Descripción |
+| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `sustituciones` | | Una tabla de sustituciones que se deben hacer a la ruta. |
+| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd del intérprete de comandos de Fish. |
+| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. |
`substitutions` permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish.
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta `/built/this/city/on/rock/and/roll`, que normalmente se mostraría como `rock/and/roll`, se mostraría como `/b/t/c/o/rock/and/roll` con `fish_style_pwd_dir_length = 1`--los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para `fish_style_pwd_dir_length = 2`, sería `/bu/th/ci/on/rock/and/roll`.
@@ -1037,8 +1092,8 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos
| Variable | Ejemplo | Descripción |
| --------- | --------------------- | ------------------------------------- |
-| path | `"D:/Projects"` | La ruta de directorio actual |
-| style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` |
+| ruta | `'D:/Projects'` | La ruta del directorio actual |
+| style\* | `'black bold dimmed'` | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@@ -1049,11 +1104,11 @@ Consideremos la ruta `/path/to/home/git_repo/src/lib`
| Variable | Ejemplo | Descripción |
| ------------------ | --------------------- | --------------------------------------------------- |
-| before_root_path | `"/path/to/home/"` | La ruta antes de la ruta del directorio raíz de git |
-| repo_root | `"git_repo"` | El nombre del directorio raíz de git |
-| path | `"/src/lib"` | La ruta restante |
-| style | `"black bold dimmed"` | Refleja el valor de la opción `style` |
-| repo_root_style | `"underline white"` | Estilo para el nombre del directorio raíz de git |
+| before_root_path | `'/path/to/home/'` | La ruta antes de la ruta del directorio raíz de git |
+| repo_root | `'git_repo'` | El nombre del directorio raíz de git |
+| ruta | `'/src/lib'` | La ruta restante |
+| style | `'black bold dimmed'` | Refleja el valor de la opción `style` |
+| repo_root_style | `'underline white'` | Estilo para el nombre del directorio raíz de git |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,11 +416,19 @@ Por favor, revisa estos proyectos que inspiraron la creación de Starship. 🙏
- **[reujab/silver](https://github.com/reujab/silver)** - Un prompt multi-intérprete de comandos personalizable basada en Powerline con iconos.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
-
+
Este proyecto está bajo una licencia [ISC](https://github.com/starship/starship/blob/master/LICENSE).
+Derechos de autor © 2019-presente, [Colaboradores de Starship](https://github.com/starship/starship/graphs/contributors).
Este proyecto está bajo una licencia [ISC](https://github.com/starship/starship/blob/master/LICENSE).
diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md
index 3eeca9aa7..062405d71 100644
--- a/docs/es-ES/presets/README.md
+++ b/docs/es-ES/presets/README.md
@@ -10,6 +10,14 @@ Este preajuste cambia los símbolos de cada módulo para usar símbolos Nerd Fon
[](./nerd-font)
+## [Sin fuentes Nerd](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Segmentos entre Corchetes](./bracketed-segments.md)
Este preajuste cambia el formato de todos los módulos incorporados para mostrar su segmento entre corchetes en lugar de usar la redacción por defecto de Starship ("via", "on", etc.).
@@ -28,6 +36,12 @@ Este preajuste oculta la versión de los tiempos de ejecución del idioma. Si tr
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Prompt de Pure](./pure-preset.md)
Esta preajuste emula la apariencia y el comportamiento de [Pure](https://github.com/sindresorhus/pure).
@@ -38,4 +52,10 @@ 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.
-[](./pastel-powerline)
+[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/es-ES/presets/no-empty-icons.md b/docs/es-ES/presets/no-empty-icons.md
new file mode 100644
index 000000000..eaebf2abe
--- /dev/null
+++ b/docs/es-ES/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Volver a Preajustes](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuración
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Clic para descargar TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/es-ES/presets/no-nerd-font.md b/docs/es-ES/presets/no-nerd-font.md
new file mode 100644
index 000000000..42da95fae
--- /dev/null
+++ b/docs/es-ES/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Volver a Preajustes](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+Esto significa que incluso sin una fuente Nerd instalada, debería ser capaz de ver todos los símbolos del módulo.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuración
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Clic para descargar TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/es-ES/presets/tokyo-night.md b/docs/es-ES/presets/tokyo-night.md
new file mode 100644
index 000000000..129632297
--- /dev/null
+++ b/docs/es-ES/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Volver a Preajustes](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Prerequisitos
+
+- Una [Nerd Font](https://www.nerdfonts.com/) instalada y habilitada en tu terminal
+
+### Configuración
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Clic para descargar TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/fr-FR/advanced-config/README.md b/docs/fr-FR/advanced-config/README.md
index 86c1ac817..2fcf79084 100644
--- a/docs/fr-FR/advanced-config/README.md
+++ b/docs/fr-FR/advanced-config/README.md
@@ -45,7 +45,7 @@ end
load(io.popen('starship init cmd'):read("*a"))()
```
-- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
+- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. This function receives the current prompt as a string that you can utilize. Par exemple, pour afficher l'heure à laquelle la dernière commande a été lancée ici, vous feriez
```lua
function starship_transient_rprompt_func(prompt)
@@ -54,7 +54,7 @@ end
load(io.popen('starship init cmd'):read("*a"))()
```
-## TransientPrompt and TransientRightPrompt in Fish
+## TransientPrompt et TransientRightPrompt dans Fish
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `enable_transience` in the shell session. To make it permanent, put this statement in your `~/.config/fish/config.fish`. Transience can be disabled on-the-fly with `disable_transience`.
@@ -70,7 +70,7 @@ starship init fish | source
enable_transience
```
-- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. For example, to display the time at which the last command was started here, you would do
+- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. Par exemple, pour afficher l'heure à laquelle la dernière commande a été lancée ici, vous feriez
```fish
function starship_transient_rprompt_func
@@ -205,7 +205,9 @@ Certains shells peuvent gérer une invite de commande à droite, sur la même li
Note: l’invite à droite est une seule ligne, sur la même ligne que l’entrée. Pour aligner à droite les modules au-dessus de la ligne d’entrée d’une invite multiligne, voir le [module `fill`](/config/#fill).
-`right_format` est actuellement géré pour les shells suivants: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ Si plusieurs couleurs sont définies pour l’avant-plan/arrière-plan, la derni
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md
index 1b4bbc29f..30ad1c437 100644
--- a/docs/fr-FR/config/README.md
+++ b/docs/fr-FR/config/README.md
@@ -9,21 +9,23 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Toute la configuration de starship est effectuée dans ce fichier [TOML](https://github.com/toml-lang/toml) :
```toml
-# Pour avoir des complétions dans votre éditeur basées sur le schéma de la config
+# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'
-# Insère un ligne vide entre les invites de shells
+# Inserts a blank line between shell prompts
add_newline = true
-# Remplace le symbole «❯» dans l’invite par «➜»
-[character] # Le nom du module que nous configurons est «character»
-success_symbol = "[➜](bold green)" # Le segment «success_symbol» est mis défini à «➜» avec la couleur «bold green»
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
-# Désactive le module «package», le cachant complètement de l’invite
+# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
Vous pouvez choisir l'emplacement du fichier avec la variable d'environnement `STARSHIP_CONFIG`:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Par convention, la plupart des modules ont un préfixe de la couleur par défaut du terminal (par exemple `via` dans "nodejs") et un espace vide comme suffixe.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+Par exemple :
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Chaîne de formatage
Les chaînes de formatage sont le format avec lequel un module affiche toutes ses variables. La plupart des modules ont une entrée appelée `format` qui configure le format d'affichage du module. Vous pouvez utiliser des textes, des variables et des groupes de texte dans une chaîne de format.
@@ -80,9 +138,9 @@ Une variable contient un symbole `$` suivi du nom de la variable. Le nom d’une
Par exemple :
-- `$version` est une chaîne de formatage avec une variable nommée `version`.
-- `$git_branch$git_commit` est une chaîne de formatage avec deux variables appelées `git_branch` et `git_commit`.
-- `$git_branch $git_commit` a les deux variables séparées par un espace.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Groupe de texte
@@ -94,20 +152,20 @@ La deuxième partie, qui est entourée par `()`, est une [chaîne de style](#sty
Par exemple :
-- `[on](red bold)` affichera une chaîne de caractères `on` avec un texte gras de couleur rouge.
-- `[⌘ $version](bold green)` affichera le symbole `⌘` suivi par le contenu de la variable `version`, en texte gras de couleur verte.
-- `[a [b](red) c](green)` affichera `a b c` avec `b` rouge, et `a` et `c` vert.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Chaînes de style
La plupart des modules de Starship vous permettent de configurer leurs styles d'affichage. Cela se fait avec une entrée (généralement appelée `style`) qui est une chaîne de caractères spécifiant la configuration. Voici quelques exemples de chaînes de style avec ce qu'elles font. Pour plus de détails sur la syntaxe complète, consultez le [guide de configuration avancé](/advanced-config/).
-- `"fg:green bg:blue"` définit un texte vert sur un fond bleu
-- `"bg:blue fg:bright-green"` définit un texte vert clair sur un fond bleu
-- `"bold fg:27"` définit le texte en gras avec la [couleur ANSI](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` définit le texte en souligné sur un fond orange foncé
-- `"bold italic fg:purple"` définit le texte en italique et gras sur un fond violet
-- `""` désactive explicitement tous les styles
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Notez que ce style sera contrôlé par votre émulateur de terminal. Par exemple, certains émulateurs de terminal éclairciront les couleurs au lieu de mettre le texte en gras, et certains thèmes de couleurs utilisent les mêmes valeurs pour les couleurs normales et claires. De plus, pour obtenir du texte italique, votre terminal doit prendre en charge l'italique.
@@ -117,87 +175,64 @@ Une chaîne de formatage conditionnel enveloppée dans `(` et `)` ne sera pas re
Par exemple :
-- `(@$region)` n’affichera rien si la variable `region` est `None` or une chaine vide, sinon `@` suivi par la valeur de region.
-- `(some text)` ne montrera toujours rien puisqu'il n'y a pas de variables enveloppées dans les accolades.
-- Lorsque `$all` est un raccourci pour `\[$a$b\]`, `($all)` ne montrera rien que si `$a` et `$b` sont tous les deux `None`. Cela fonctionne comme `(\[$a$b\] )`.
-
-#### Caractères spéciaux
-
-Les caractères suivants ont une utilisation spéciale dans les chaines de formatage et doivent être échappées : `$ \ [ ] ( )`.
-
-Notez que TOML a [à la fois des chaines basiques et des chaines littérales](https://toml.io/en/v1.0.0#string). Il est recommandé d'utiliser une chaine littérale (entourée de guillemets simples) dans votre configuration. Si vous voulez utiliser une chaîne basique (entourée de guillemets doubles), vous devez échapper l'antislash lui-même (c-à-d. utiliser `\\`).
-
-Par exemple, lorsque vous voulez imprimer un symbole `$` sur une nouvelle ligne, les configurations suivantes pour le `formatage` sont équivalentes :
-
-```toml
-# avec la chaîne de base
-format = "\n\\$"
-
-# avec la chaîne de caractères de base multiligne
-format = """
-
-\\$"""
-
-# avec la chaîne littérale
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Invite
-Voici la liste des options de configuration de l'invite en lui-même.
+Voici la liste des options de configuration globales de l'invite de commandes.
### Options
| Option | Défaut | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [lien](#default-prompt-format) | Configure le format de l'invite. |
-| `right_format` | `""` | Voir [Activer le prompt à droite](/advanced-config/#enable-right-prompt) |
-| `scan_timeout` | `30` | Délai d'attente pour que starship scanne les fichiers (en millisecondes). |
+| `right_format` | `''` | Voir [Activer le prompt à droite](/advanced-config/#enable-right-prompt) |
+| `scan_timeout` | `30` | Délai maximal pour le scan des fichiers par starship (en millisecondes). |
| `command_timeout` | `500` | Délai maximal pour les commandes exécutées par starship (en millisecondes). |
| `add_newline` | `true` | Insère une ligne vide entre les invites du shell. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Exemple
```toml
-# ~/.config/starship. oml
+# ~/.config/starship.toml
-# Utilisez un format personnalisé
-format = """
+# Use custom format
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
-# Attendez 10 millisecondes pour que starship vérifie les fichiers dans le répertoire de travail.
+# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Format par Défaut
@@ -205,7 +240,7 @@ mustard = "#af8700"
Le `format` par défaut est utilisé pour définir le format de l'invite, si il est vide ou mal `formaté`. La valeur par défaut est la suivante :
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -289,8 +328,8 @@ $character"""
Si vous voulez étendre le format par défaut, pour pouvoir utiliser `$all` ; les modules que vous ajouter explicitement au format ne seront pas dupliqués. Par ex.
```toml
-# Déplace le dossier à la ligne suivante
-format = "$all$directory$character"
+# Move the directory to the second line
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ Lorsque vous utilisez [awsu](https://github.com/kreuzwerker/awsu) le profil est
Lorsque vous utilisez [AWSume](https://awsu.me) le profil est lu à partir de la variable d'environnement `AWSUME_PROFILE` et la date d'expiration des identifiants est lue à partir de la variable d'environnement `AWSUME_EXPIRATION`.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
| Option | Défaut | Description |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Format du module. |
-| `symbol` | `"☁️ "` | Le symbole est affiché avant le profil AWS actuel. |
-| `region_aliases` | | Tableau des alias de région à afficher en plus du nom AWS. |
-| `profile_aliases` | | Tableau des alias de profil à afficher en plus du nom AWS. |
-| `style` | `"bold yellow"` | Le style du module. |
+| `symbol` | `'☁️ '` | Le symbole est affiché avant le profil AWS actuel. |
+| `region_aliases` | `{}` | Tableau des alias de région à afficher en plus du nom AWS. |
+| `profile_aliases` | `{}` | Tableau des alias de profil à afficher en plus du nom AWS. |
+| `style` | `'bold yellow'` | Le style pour le module. |
| `expiration_symbol` | `X` | Le symbole est affiché lorsque les identifiants temporaires ont expiré. |
| `disabled` | `false` | Désactive le module `AWS`. |
| `force_display` | `false` | Si `true`, affiche les informations même si `credentials`, `credential_process` ou `sso_start_url` n'ont pas été configurées. |
@@ -339,11 +380,11 @@ Lorsque vous utilisez [AWSume](https://awsu.me) le profil est lu à partir de la
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Afficher le profil
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-Le module `azure` affiche l'abonnement Azure actuel. Ceci est basé sur l'affichage du nom de l'abonnement par défaut, tel que défini dans le fichier `~/.azure/azureProfile.json`.
+Le module `azure` affiche l'abonnement Azure actuel. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| Variable | Défaut | Description |
| ---------- | ---------------------------------------- | ---------------------------------------- |
-| `format` | `"on [$symbol($subscription)]($style) "` | Le format pour le rendu du module Azure. |
-| `symbol` | `"ﴃ "` | Le symbole utilisé dans le format. |
-| `style` | `"blue bold"` | Le style utilisé dans le format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | Le format pour le rendu du module Azure. |
+| `symbol` | `'ﴃ '` | Le symbole utilisé dans le format. |
+| `style` | `'blue bold'` | Le style utilisé dans le format. |
| `disabled` | `true` | Désactive le module `azure`. |
-### Exemple
+### Exemples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ Le module `battery` montre à quel point la batterie de l'appareil est chargée
| Option | Défaut | Description |
| -------------------- | --------------------------------- | ------------------------------------------------------------- |
-| `full_symbol` | `" "` | Le symbole affiché lorsque la batterie est pleine. |
-| `charging_symbol` | `" "` | Le symbole affiché lorsque la batterie se charge. |
-| `discharging_symbol` | `" "` | Le symbole affiché lorsque la batterie se décharge. |
-| `unknown_symbol` | `" "` | Le symbole affiché lorsque l'état de la batterie est inconnu. |
-| `empty_symbol` | `" "` | Le symbole affiché lorsque la batterie est vide. |
-| `format` | `"[$symbol$percentage]($style) "` | Format du module. |
+| `full_symbol` | `' '` | Le symbole affiché lorsque la batterie est pleine. |
+| `charging_symbol` | `' '` | Le symbole affiché lorsque la batterie se charge. |
+| `discharging_symbol` | `' '` | Le symbole affiché lorsque la batterie se décharge. |
+| `unknown_symbol` | `' '` | Le symbole affiché lorsque l'état de la batterie est inconnu. |
+| `empty_symbol` | `' '` | Le symbole affiché lorsque la batterie est vide. |
+| `format` | `'[$symbol$percentage]($style) '` | Format du module. |
| `display` | [lien](#battery-display) | Affiche le seuil et le style du module. |
| `disabled` | `false` | Désactive le module `battery`. |
@@ -423,9 +478,9 @@ Le module `battery` montre à quel point la batterie de l'appareil est chargée
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Indicateur de batterie
@@ -435,35 +490,35 @@ L'option de configuration `display` est utilisée pour définir quand l'indicate
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
La valeur par défaut pour les options `charging_symbol` et `discharging_symbol` est respectivement la valeur des options `charging_symbol` et `discharging_symbol` du module `battery`.
#### Options
-L'option `display` est une array de la table suivante.
+L'option `display` est un tableau des propriétés suivantes.
| Option | Défaut | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
-| `threshold` | `10` | La limite supérieure pour l'option d'affichage. |
-| `style` | `"red bold"` | Le style de l'option display si elle est utilisée. |
+| `threshold` | `10` | La limite supérieure pour l'option display. |
+| `style` | `'red bold'` | Le style de l'option display si elle est utilisée. |
| `charging_symbol` | | Symbole optionnel affiché si l'option display est utilisée, la valeur par défaut est l'option `charging_symbol` du module "battery". |
| `discharging_symbol` | | Symbole optionnel affiché si l'option display est utilisée, la valeur par défaut est l'option `discharging_symbol` du module "battery". |
#### Exemple
```toml
-[[battery.display]] # style "bold red" et discharging_symbol quand la batterie est entre 0% et 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # style "bold yellow" et symbole 💦 quand la batterie est entre 10% et 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
-# quand la batterie est au-dessus de 30%, l’indicateur de batterie ne sera pas affiché
+# when capacity is over 30%, the battery indicator will not be displayed
```
## Buf
@@ -475,16 +530,16 @@ Le module `buf` affiche la version de [Buf](https://buf.build) installée. Par d
### Options
-| Option | Défaut | Description |
-| ------------------- | ----------------------------------------------- | ------------------------------------------------------ |
-| `format` | `"with [$symbol($version )]($style)"` | Le format du module `buf`. |
-| `version_format` | `"v${raw}"` | Le format de la version. |
-| `symbol` | `"🦬 "` | Le symbole utilisé avant d’afficher la version de Buf. |
-| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
-| `style` | `"bold blue"` | Le style du module. |
-| `disabled` | `false` | Désactive le module `elixir`. |
+| Option | Défaut | Description |
+| ------------------------------------ | ----------------------------------------------- | ------------------------------------------------------ |
+| `format` | `'with [$symbol($version )]($style)'` | Le format du module `buf`. |
+| `version_format` | `'v${raw}'` | Le format de la version. |
+| `symbol` | `'🦬 '` | Le symbole utilisé avant d’afficher la version de Buf. |
+| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Les fichiers qui activent ce module. |
+| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
+| `style` | `'bold blue'` | Le style pour le module. |
+| `disabled` | `false` | Désactive le module `elixir`. |
### Variables
@@ -502,28 +557,28 @@ Le module `buf` affiche la version de [Buf](https://buf.build) installée. Par d
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
-The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
+The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
- Le répertoire courant contient un fichier `bun.lockb`
- Le répertoire courant contient un fichier `bunfig.toml`
### Options
-| Option | Défaut | Description |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🍞 "` | Une chaîne de caractères représentant le symbole de Node.js. |
-| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
-| `style` | `"bold green"` | Le style du module. |
-| `disabled` | `false` | Disables the `bun` module. |
+| Option | Défaut | Description |
+| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
+| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Les fichiers qui activent ce module. |
+| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
+| `style` | `'bold red'` | Le style pour le module. |
+| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -550,17 +605,17 @@ Le module `c` affiche des informations à propos de votre compilateur C. Par dé
### Options
-| Option | Défaut | Description |
-| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | La chaîne de format pour le module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | Le symbole utilisé avant d’afficher les détails du compilateur |
-| `detect_extensions` | `["c", "h"]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `[]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | Comment détecter quel est le compilateur |
-| `style` | `"bold 149"` | Le style du module. |
-| `disabled` | `false` | Désactive le module `c`. |
+| Option | Défaut | Description |
+| ------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | La chaîne de format pour le module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | Le symbole utilisé avant d’afficher les détails du compilateur |
+| `detect_extensionsdetect_extensions` | `['c', 'h']` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `[]` | Les fichiers qui activent ce module. |
+| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | Comment détecter quel est le compilateur |
+| `style` | `'bold 149'` | Le style pour le module. |
+| `disabled` | `false` | Désactive le module `c`. |
### Variables
@@ -577,7 +632,7 @@ Notez que `version` n’est pas dans le format par défaut.
L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom.
-Chaque commande est représentée par une liste du nom de l'exécutable suivie de ses arguments, généralement quelque chose comme `["mycc", "--version"]`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT.
Si un compilateur C n’est pas supporté par ce module, vous pouvez demander son ajout en [créant un ticket sur GitHub](https://github.com/starship/starship/).
@@ -587,19 +642,19 @@ Si un compilateur C n’est pas supporté par ce module, vous pouvez demander so
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Caractères
-Le module `character` affiche un caractère (habituellement une flèche) à côté de l'endroit où le texte est entré dans votre terminal.
+Le module `character` affiche un caractère (en général une flèche) à côté de là où vous entrez le texte dans votre terminal.
-Le caractère vous dira si la dernière commande a été réussie ou pas. Cela peut être fait de deux manières:
+Le caractère vous dira si la dernière commande a été réussie ou pas. Il peut faire ça de deux façons:
- en changeant de couleur(`red`/`green`)
- en changeant de forme (`❯`/`✖`)
-Par défaut, il ne change que la couleur. Si vous désirez également changer sa forme, jetez un œil à [cet exemple](#with-custom-error-shape).
+Par défaut, il ne change que de couleur. Si vous désirez également changer sa forme, jetez un à [cet exemple](#with-custom-error-shape).
::: warning
@@ -611,13 +666,13 @@ Par défaut, il ne change que la couleur. Si vous désirez également changer sa
| Option | Défaut | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | Le format utilisée avant l'entrée de texte. |
-| `success_symbol` | `"[❯](bold green)"` | Le format utilisé avant l'entrée de texte si la commande précédente a réussi. |
-| `error_symbol` | `"[❯](bold red)"` | Le format utilisé avant l'entrée de texte si la commande précédente a échoué. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | Le format utilisé avant l'entrée de texte si le shell est en mode vim normal. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | Le format utilisé avant l'entrée de texte. |
+| `success_symbol` | `'[❯](bold green)'` | Le format utilisé avant l'entrée de texte si la commande précédente a réussi. |
+| `error_symbol` | `'[❯](bold red)'` | Le format utilisé avant l'entrée de texte si la commande précédente a échoué. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | Le format utilisé avant l'entrée de texte si le shell est en mode vim normal. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Désactive le module `character`. |
### Variables
@@ -634,8 +689,8 @@ Par défaut, il ne change que la couleur. Si vous désirez également changer sa
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Sans caractère d'erreur personnalisé
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### Avec une forme vim personnalisée
@@ -654,28 +709,28 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
-Le module `cmake` affiche la version actuellement installée de [CMake](https://cmake.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
+Le module `cmake` affiche la version de [CMake](https://cmake.org/) installée. Par défaut, le module s’activera si l’une de ces conditions est remplie:
- Le dossier courant contient un fichier `CMakeLists.txt`
- Le dossier courant contient un fichier `CMakeCache.txt`
### Options
-| Option | Défaut | Description |
-| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. |
-| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Quels fichiers devraient activer ce module |
-| `detect_folders` | `[]` | Quels dossiers devraient activer ce module |
-| `style` | `"bold blue"` | Le style du module. |
-| `disabled` | `false` | Désactive le module `cmake`. |
+| Option | Défaut | Description |
+| ------------------------------------ | -------------------------------------- | ------------------------------------------------------------------------------------------ |
+| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'△ '` | Le symbole utilisé avant la version de cmake. |
+| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Quels fichiers devraient activer ce module |
+| `detect_folders` | `[]` | Quels dossiers devraient activer ce module |
+| `style` | `'bold blue'` | Le style pour le module. |
+| `disabled` | `false` | Désactive le module `cmake`. |
### Variables
@@ -689,23 +744,23 @@ Le module `cmake` affiche la version actuellement installée de [CMake](https://
## COBOL / GNUCOBOL
-Le module `cobol` affiche la version de COBOL installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie :
+Le module `cobol` affiche la version de COBOL installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
- Le dossier courant contient un fichier finissant par `.cob` ou `.COB`
- Le dossier courant contiens un fichier finissant par `.cbl` ou `.CBL`
### Options
-| Option | Défaut | Description |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `symbol` | `"⚙️ "` | Le symbole utilisé avant d’afficher la version de COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | Le style du module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `[]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
-| `disabled` | `false` | Désactive le module `cobol`. |
+| Option | Défaut | Description |
+| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `symbol` | `'⚙️ '` | Le symbole utilisé avant d’afficher la version de COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | Le style pour le module. |
+| `detect_extensionsdetect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `[]` | Les fichiers qui activent ce module. |
+| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
+| `disabled` | `false` | Désactive le module `cobol`. |
### Variables
@@ -719,15 +774,15 @@ Le module `cobol` affiche la version de COBOL installée. Par défaut, le module
## Temps d'exécution
-Le module `cmd_duration` montre le temps qu'a pris la dernière commande a pris pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou si la valeur de configuration `min_time` existe.
+Le module `cmd_duration` montre le temps qu'a pris la dernière commande pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou plus que la valeur `min_time`, si elle existe.
-::: warning N'interceptez pas le signal DEBUG avec Bash
+::: warning N'accrochez pas la trappe DEBUG en Bash
-Si vous utilisez starship en `bash`, n'accrochez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **cassera**.
+Si vous utilisez starship avec `bash`, n'interceptez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **ne fonctionnera pas**.
:::
-Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les array `preexec_functions` et `precmd_functions` avant d'éxécuter `eval $(starship init $0)`, puis procédez comme d'habitude.
+Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les tableaux `preexec_functions` et `precmd_functions` avant d'exécuter `eval $(starship init $0)`, puis procédez comme d'habitude.
### Options
@@ -735,8 +790,8 @@ Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent uti
| ---------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Durée la plus courte quand afficher le temps (en millisecondes). |
| `show_milliseconds` | `false` | Afficher les millisecondes en plus des secondes pendant la durée. |
-| `format` | `"took [$duration]($style) "` | Format du module. |
-| `style` | `"bold yellow"` | Le style du module. |
+| `format` | `'took [$duration]($style) '` | Format du module. |
+| `style` | `'bold yellow'` | Le style pour le module. |
| `disabled` | `false` | Désactive le module `cmd_duration`. |
| `show_notifications` | `false` | Afficher les notifications du bureau lorsque la commande est terminée. |
| `min_time_to_notify` | `45_000` | Durée minimale après laquelle activer la notification (en millisecondes). |
@@ -758,7 +813,7 @@ Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent uti
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -767,7 +822,7 @@ Le module `conda` affiche l’environnement [Conda](https://docs.conda.io/en/lat
::: tip
-Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `conda config --set changeps1 False`.
+Cela ne supprime pas le modificateur d'invite de conda, vous pourriez vouloir exécuter `conda config --set changeps1 False` pour le désactiver.
:::
@@ -776,19 +831,19 @@ Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `c
| Option | Défaut | Description |
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | Le nombre de répertoires dans lesquels le chemin d'environnement (Path) doit être tronqué, si l'environnement a été créé via `conda create -p [path]`. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). |
-| `symbol` | `"🅒 "` | Le symbole utilisé avant le nom d'environnement. |
-| `style` | `"bold green"` | Le style du module. |
-| `format` | `"via [$symbol$environment]($style) "` | Format du module. |
+| `symbol` | `'🅒 '` | Le symbole utilisé avant le nom d'environnement. |
+| `style` | `'bold green'` | Le style pour le module. |
+| `format` | `'via [$symbol$environment]($style) '` | Format du module. |
| `ignore_base` | `true` | Ignore l'environnement `base` lorsqu'il est activé. |
| `disabled` | `false` | Désactive le module `conda`. |
### Variables
-| Variable | Exemple | Description |
-| ------------- | ------------ | -------------------------------------- |
-| environnement | `astronauts` | La version courante de conda |
-| symbol | | Reflète la valeur de l'option `symbol` |
-| style\* | | Reflète la valeur de l'option `style` |
+| Variable | Exemple | Description |
+| ----------- | ------------ | -------------------------------------- |
+| environment | `astronauts` | La version courante de conda |
+| symbol | | Reflète la valeur de l'option `symbol` |
+| style\* | | Reflète la valeur de l'option `style` |
*: Cette variable peut uniquement être utilisée dans une chaine de style
@@ -798,7 +853,7 @@ Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Conteneur
@@ -809,8 +864,8 @@ Le module `container` affiche un symbole et le nom du conteneur, si vous êtes d
| Option | Défaut | Description |
| ---------- | ---------------------------------- | ---------------------------------------------------- |
-| `symbol` | `"⬢"` | Le symbole affiché quand vous êtes dans un conteneur |
-| `style` | `"bold red dimmed"` | Le style du module. |
+| `symbol` | `'⬢'` | Le symbole affiché quand vous êtes dans un conteneur |
+| `style` | `'bold red dimmed'` | Le style pour le module. |
| `format` | `'[$symbol \[$name\]]($style) '` | Format du module. |
| `disabled` | `false` | Désactive le module `container`. |
@@ -835,29 +890,29 @@ format = '[$symbol \[$name\]]($style) '
## Crystal
-Le module `crystal` affiche la version actuellement installée de [Crystal](https://crystal-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
+Le module `crystal` affiche la version de [Crystal](https://crystal-lang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
- Le répertoire courant contient un fichier `shard.yml`
- Le répertoire courant contient un fichier `.cr`
### Options
-| Option | Défaut | Description |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold green"` | Le style du module. |
-| `detect_extensions` | `["cr"]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `["shard.yml"]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
-| `disabled` | `false` | Désactive le module `crystal`. |
+| Option | Défaut | Description |
+| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `symbol` | `'🔮 '` | Le symbole utilisé avant d'afficher la version de crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | Le style pour le module. |
+| `detect_extensionsdetect_extensions` | `['cr']` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `['shard.yml']` | Les fichiers qui activent ce module. |
+| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
+| `disabled` | `false` | Désactive le module `crystal`. |
### Variables
| Variable | Exemple | Description |
| --------- | --------- | -------------------------------------- |
-| version | `v0.32.1` | La version de `cristal` |
+| version | `v0.32.1` | La version de `crystal` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
@@ -869,27 +924,27 @@ Le module `crystal` affiche la version actuellement installée de [Crystal](http
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
-The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
+The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
- Le répertoire courant contient un fichier `daml.yaml`
### Options
-| Option | Défaut | Description |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
-| `style` | `"bold cyan"` | Le style du module. |
-| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `["daml.yaml"]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
-| `disabled` | `false` | Disables the `daml` module. |
+| Option | Défaut | Description |
+| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | Le style pour le module. |
+| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `['daml.yaml']` | Les fichiers qui activent ce module. |
+| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
+| `disabled` | `false` | Disables the `daml` module. |
### Variables
@@ -907,12 +962,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
-Le module `dart` affiche la version actuellement installée de [Dart](https://dart.dev/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
+Le module `dart` affiche la version de [Dart](https://dart.dev/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
- Le répertoire courant contient un fichier `.dart`
- Le répertoire courant contient un répertoire `.dart_tool`
@@ -920,16 +975,16 @@ Le module `dart` affiche la version actuellement installée de [Dart](https://da
### Options
-| Option | Défaut | Description |
-| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart |
-| `detect_extensions` | `["dart"]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[".dart_tool"]` | Les dossiers qui activent ce module. |
-| `style` | `"bold blue"` | Le style du module. |
-| `disabled` | `false` | Désactive le module `dart`. |
+| Option | Défaut | Description |
+| ------------------------------------ | ------------------------------------------------- | ------------------------------------------------------------------------------------------ |
+| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | Une chaîne de caractères représentant le symbole de Dart |
+| `detect_extensionsdetect_extensions` | `['dart']` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Les fichiers qui activent ce module. |
+| `detect_folders` | `['.dart_tool']` | Les dossiers qui activent ce module. |
+| `style` | `'bold blue'` | Le style pour le module. |
+| `disabled` | `false` | Désactive le module `dart`. |
### Variables
@@ -947,27 +1002,27 @@ Le module `dart` affiche la version actuellement installée de [Dart](https://da
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
-Le module `deno` affiche la version actuellement installée de [Deno](https://deno.land/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
+Le module `deno` affiche la version de [Deno](https://deno.land/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
- Le répertoire actuel contient un fichier `deno.json`, `deno.jsonc`, `mod.ts`, `mod.ts`, `mod.js`, `deps.ts`, ou `deps.js`
### Options
-| Option | Défaut | Description |
-| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
-| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🦕 "` | Une chaîne de caractères représentant le symbole de Deno |
-| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Les fichiers qui activent ce module. |
-| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
-| `style` | `"green bold"` | Le style du module. |
-| `disabled` | `false` | Désactive le module `deno`. |
+| Option | Défaut | Description |
+| ------------------------------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
+| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
+| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🦕 '` | Une chaîne de caractères représentant le symbole de Deno |
+| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Les fichiers qui activent ce module. |
+| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
+| `style` | `'green bold'` | Le style pour le module. |
+| `disabled` | `false` | Désactive le module `deno`. |
### Variables
@@ -983,40 +1038,41 @@ Le module `deno` affiche la version actuellement installée de [Deno](https://de
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Dossier
-Le mode `directory` montre le chemin de votre dossier actuel, tronqué aux 3 dossiers parents. Votre répertoire sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement.
+Le module `directory` affiche le chemin du dossier courant, tronqué à 3 dossiers parents. Votre dossier sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement.
-Quand vous utilisez le style pwd de fish, au lieu de cacher le chemin qui est tronqué, vous verrez un nom raccourci de chaque dossier basé sur le nombre établi pour l'option.
+Lorsque vous utilisez le style de pwd de fish, au lieu de cacher le chemin tronqué, vous verrez une abréviation du nom de chaque dossier, en fonction du nombre que vous avez utilisé comme valeur.
-Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo, et l'option définie à `1`. Vous verrez maintenant `~/D/N/nixpkgs/pkgs`, alors que vous auriez vu `nixpkgs/pkgs` avant.
+Par exemple, `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo, et l'option définie à `1`. Vous verrez maintenant `~/D/N/nixpkgs/pkgs`, alors que vous auriez vu `nixpkgs/pkgs` avant.
### Options
-| Option | Défaut | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | Le nombre de dossiers parents selon lesquels le répertoire courant doit être tronqué. |
-| `truncate_to_repo` | `true` | Si oui ou non tronquer à la racine du repo git dans lequel vous vous trouvez. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format du module. |
-| `style` | `"bold cyan"` | Le style du module. |
-| `disabled` | `false` | Désactive le module `directory`. |
-| `read_only` | `"🔒"` | Le symbole indiquant que le répertoire courant est en lecture seule. |
-| `read_only_style` | `"red"` | Le style du symbole en lecture seule. |
-| `truncation_symbol` | `""` | Le symbole en préfixe aux chemins tronqués. eg: "…/" |
-| `repo_root_style` | | Le style pour la racine du dépôt Git. La valeur par défaut est équivalent à `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | Le format d’un dépôt Git quand `repo_root_style` est défini. |
-| `home_symbol` | `"~"` | Le symbole indiquant le répertoire personnel. |
-| `use_os_path_sep` | `true` | Utiliser le séparateur de chemin du système d’exploitation au lieu de toujours utiliser `/` (par ex. `\` sous Windows) |
+| Option | Défaut | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | Le nombre de dossiers parents auquel tronquer le chemin du répertoire courant. |
+| `truncate_to_repo` | `true` | Si oui ou non tronquer à la racine du repo git dans lequel vous vous trouvez. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | Format du module. |
+| `style` | `'bold cyan'` | Le style pour le module. |
+| `disabled` | `false` | Désactive le module `directory`. |
+| `read_only` | `'🔒'` | Le symbole indiquant que le répertoire courant est en lecture seule. |
+| `read_only_style` | `'red'` | Le style du symbole de lecture seule. |
+| `truncation_symbol` | `''` | Le symbole pour préfixer les chemins tronqués. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. La valeur par défaut est équivalent à `style`. |
+| `repo_root_style` | | Le style pour la racine du dépôt Git. La valeur par défaut est équivalent à `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | Le symbole indiquant le répertoire personnel. |
+| `use_os_path_sep` | `true` | Utiliser le séparateur de chemin du système d’exploitation au lieu de toujours utiliser `/` (par ex. `\` sous Windows) |
Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire.
| Options avancées | Défaut | Description |
| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `substitutions` | | Table de substitutions à faire au chemin. |
+| `substitutions` | | Une table de substitutions à appliquer aux chemins. |
| `fish_style_pwd_dir_length` | `0` | Le nombre de caractères à utiliser lors de l'application de la logique de troncature du pwd de fish. |
| `use_logical_path` | `true` | Si `true` affiche le chemin logique issu du shell via `PWD` ou `--logical-path`. Si `false` renvoie plutôt le chemin du système de fichiers physique avec les liens symboliques résolus. |
@@ -1024,8 +1080,8 @@ Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_leng` interagit avec les options de troncature d'une manière qui peut être surprenante au début : si elle n'est pas nulle, les composantes du chemin qui seraient normalement tronquées sont affichées à la place avec autant de caractères. Par exemple, le chemin `/built/this/city/on/rock/and/roll`, qui devrait normalement être affiché comme `rock/and/roll`, sera affiché sous la forme de `/b/t/c/o/rock/and/roll` avec `fish_style_pwd_dir_length = 1`--les composants de chemin qui seraient normalement supprimés sont affichés avec un caractère unique. Pour `fish_style_pwd_dir_length = 2`, ce serait `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo
| Variable | Exemple | Description |
| --------- | --------------------- | ------------------------------------- |
-| path | `"D:/Projects"` | Le chemin du répertoire courant |
-| style\* | `"black bold dimmed"` | Reflète la valeur de l'option `style` |
+| path | `'D:/Projects'` | Le chemin du répertoire courant |
+| style\* | `'black bold dimmed'` | Reflète la valeur de l'option `style` |
*: Cette variable peut uniquement être utilisée dans une chaine de style
@@ -1048,11 +1104,11 @@ Considérons le chemin `/path/to/home/git_repo/src/lib`
| Variable | Exemple | Description |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | Le chemin avant le dossier racine Git |
-| repo_root | `"git_repo"` | Le nom du dossier racine Git |
-| path | `"/src/lib"` | Le reste du chemin |
-| style | `"black bold dimmed"` | Reflète la valeur de l'option `style` |
-| repo_root_style | `"underline white"` | Style pour le nom du dossier racine Git |
+| before_root_path | `'/path/to/home/'` | Le chemin avant le dossier racine Git |
+| repo_root | `'git_repo'` | Le nom du dossier racine Git |
+| path | `'/src/lib'` | Le reste du chemin |
+| style | `'black bold dimmed'` | Reflète la valeur de l'option `style` |
+| repo_root_style | `'underline white'` | Style pour le nom du dossier racine Git |
`dnf install starship` |
-| Fedora 31+ | [Paquets Fedora](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Paquets Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -254,13 +253,13 @@ Install the latest version for your system with the MSI-installers from the [rel
Installez Starship en utilisant l’un de ces gestionnaires de paquets:
-| Dépôt | Instructions |
-| -------------------------------------------------------------------------------------------- | --------------------------------------- |
-| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
-| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
-| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
-| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
-| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
+| Dépôt | Instructions |
+| --------------------------------------------------------------------------------------------- | --------------------------------------- |
+| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
+| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
+| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
+| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
+| [aileron](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
-
+
Ce projet est sous licence [ISC](https://github.com/starship/starship/blob/master/LICENSE).
+Copyright © 2019-présent, [contributeurs de Starship](https://github.com/starship/starship/graphs/contributors).
Ce projet est sous licence [ISC](https://github.com/starship/starship/blob/master/LICENSE).
diff --git a/docs/fr-FR/presets/README.md b/docs/fr-FR/presets/README.md
index 3c3b27171..4cea68cc8 100644
--- a/docs/fr-FR/presets/README.md
+++ b/docs/fr-FR/presets/README.md
@@ -10,6 +10,14 @@ Ce préréglage change les symboles de chaque module pour utiliser les symboles
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Segments entre crochets](./bracketed-segments.md)
Ce préréglage modifie le format de tous les modules intégrés pour afficher leur segment entre crochets au lieu d'utiliser les labels par défaut de Starship ("via", "on", etc.).
@@ -20,13 +28,19 @@ 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.
-[](./plain-text)
+[](./plain-text)
## [Pas de version des environnements](./no-runtimes.md)
Ce préréglage masque la version des environnements. Si vous travaillez dans des conteneurs ou environnements virtuels, celui-là est pour vous!
-[](./no-runtimes)
+[](./no-runtimes)
+
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
## [Invite de commande Pure](./pure-preset.md)
@@ -39,3 +53,9 @@ Ce préréglage émule l'apparence et le comportement de [Pure](https://github.c
Ce préréglage s'inspire de [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Il montre également comment fonctionne la substitution de chemin dans starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/fr-FR/presets/no-empty-icons.md b/docs/fr-FR/presets/no-empty-icons.md
new file mode 100644
index 000000000..f09ca1c9e
--- /dev/null
+++ b/docs/fr-FR/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Retourner aux préréglages](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuration
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Cliquez pour télécharger le TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/fr-FR/presets/no-nerd-font.md b/docs/fr-FR/presets/no-nerd-font.md
new file mode 100644
index 000000000..d37eca42a
--- /dev/null
+++ b/docs/fr-FR/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Retourner aux préréglages](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuration
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Cliquez pour télécharger le TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/fr-FR/presets/tokyo-night.md b/docs/fr-FR/presets/tokyo-night.md
new file mode 100644
index 000000000..e72c28f8e
--- /dev/null
+++ b/docs/fr-FR/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Retourner aux préréglages](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Pré-requis
+
+- Une [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal
+
+### Configuration
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Cliquez pour télécharger le TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/id-ID/advanced-config/README.md b/docs/id-ID/advanced-config/README.md
index 3c1482c13..182f7d76f 100644
--- a/docs/id-ID/advanced-config/README.md
+++ b/docs/id-ID/advanced-config/README.md
@@ -205,7 +205,9 @@ Sebagian shells mendukung right prompt yang mana dirender di baris yang sama ses
Catatan: Right propmt merupakan sebuah baris yang mengikuti lokasi baris inputan. Untuk membuat modul rata ke kanan di atas baris masukan di dalam multi-line prompt, lihat [`fill` module](/config/#fill).
-`right_format` saat ini hanya dapat bekerja pada beberapa shells berikut: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ Jika warna yang dipakai pada latar depan/latar belakang banyak, maka warna yang
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/id-ID/config/README.md b/docs/id-ID/config/README.md
index 1931a27c2..626f61c66 100644
--- a/docs/id-ID/config/README.md
+++ b/docs/id-ID/config/README.md
@@ -15,15 +15,17 @@ Seluruh konfigurasi starship dilakukan dalam file [TOML](https://github.com/toml
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
Kamu bisa mengganti lokasi file konfigurasi bawaan dengan menggunakan environment variable dari `STARSHIP_CONFIG`:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Secara konvensi, sebagian modul memiliki prefiks bawaan pada warna terminal (mis. `via` pada "nodejs") dan juga sebuah ruang kosong sebagai sufiks.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+Sebagai contoh:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format String
Format string merupakan format yang sebuah modul gunakan untuk menampilkan semua variabelnya. Sebagian besar modul memiliki sebuah entri yang disebut `format` yang mengkonfigurasi format tampilan pada modul. Kamu bisa menggunakan teks, variabel, dan grup teks di dalam sebuah format string.
@@ -80,9 +138,9 @@ Variabel memilki simbol `$` yang diikuti dengan nama variabelnya. The name of a
Sebagai contoh:
-- `$version` adalah format string dengan sebuah nama variabel `version`.
-- `$git_branch$git_commit` merupakan sebuah format string dengan dua variabel bernama `git_branch` dan `git_commit`.
-- `$git_branch $git_commit` memiliki dua variabel yang dipisahkan dengan sebuah spasi.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Grup Teks
@@ -94,20 +152,20 @@ Pada bagian kedua, yang mana diapit dalam sebuah `()`, merupakan sebuah [penataa
Sebagai contoh:
-- `[on](red bold)` akan menampilkan string `on` dengan teks merah tebal.
-- `[⌘ $version](bold green)` akan menampilkan simbol `⌘` yang diikuti oleh variabel yang berisikan `version`, dengan teks tebal berwarna hijau.
-- `[a [b](red) c](green)` akan menampilkan `a b c` dengan `b` merah, dan `a` & `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Menata String
Sebagian besar modul starship memungkinkan kamu untuk mengkonfigurasi gaya tampilannya. Hal ini dilakukan dengan sebuah entri (biasanya `style`) yang konfigurasinya ditentukan oleh string. Berikut adalah beberapa contoh penataan pada string dan kegunaannya. Untuk detail sintaksis yang lebih lengkap, lihat [panduan konfigurasi lanjutan](/advanced-config/).
-- `"fg:green bg:blue"` mengeset teks berwana hijau pada latar biru
-- `"bg:blue fg:bright-green"` mengeset teks hijau terang pada latar biru
-- `"bold fg:27"` mengeset tebal teks dengan [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` mengeset teks bergaris bawah pada latar oranye menyala
-- `"bold italic fg:purple"` mengeset teks ungu miring tebal
-- `""` secara eksplisit menonaktifkan semua penataan gaya
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Perhatikan bagaimana nantinya penataanmu akan terlihat pada emulator terminalmu. Sebagai contoh, beberapa terminal emulator alih-alih membuat warnanya lebih terang, malah menebalkan teksnya, dan sebagian palet warna ada yang menggunakan nilai yang sama untuk warna normal dan terangnya. Dan juga, untuk memakai teks miring, terminalmu harus menunjang teks miring.
@@ -117,43 +175,20 @@ Sebuah string dengan format bersyarat dibungkus dengan `(` dan `)` tidak akan di
Sebagai contoh:
-- `(@$region)` tidak akan menampilkan apapun jika nilai variabel `region` adalah `None` atau berupa string kosong, jika tidak, `@` diikuti dengan nilai dari region.
-- `(sembarang)` akan selalu tidak menampilkan apapun karena tidak ada variabel yang dibungkus dalam kurung kurawal.
-- Tatkala `$all` digunakan sebagai shortcut untuk `\[$a$b\]`, `($all)` tidak akan menampilkan apapun jika nilai `$a` dan `$b` adalah `None`. Berlaku juga dengan `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-Sebagai contoh, ketika kamu ingin menampilkan simbol `$` pada sebuah baris baru, konfigurasi berikut sama halnya pada `format`:
-
-```toml
-# dengan string standar
-format = "\n\\$"
-
-# dengan string standar multibaris
-format = """
-
-\\$"""
-
-# dengan string literal
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -164,12 +199,12 @@ Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide.
| Opsi | Bawaan | Deskripsi |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `format` | [link](#default-prompt-format) | Mengkonfigurasi format pada prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `fromat` | [link](#default-prompt-format) | Mengkonfigurasi format pada prompt. |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Batas waktu starpship untuk memindai file (dalam milidetik). |
| `command_timeout` | `500` | Batas waktu untuk perintah yang dijalankan starship (dalam milidetik). |
| `add_newline` | `true` | Memasukkan baris kosong antara prompt shell. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Contoh
@@ -177,27 +212,27 @@ Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide.
```toml
# ~/.config/starship.toml
-# Menggunakan format yang dikustomisasi
-format = """
+# Use custom format
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
-# Menunggu 10 milidetik untuk starship mencek file pada direktori terkini.
+# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Format Prompt Bawaan
@@ -205,7 +240,7 @@ mustard = "#af8700"
Aturan `format` bawaan digunakan untuk mendefinisikan format pada prompt, apabila kosong atau tidak ada `format` yang diberikan. Aturannya seperti yang ditunjukkan:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ Ketika menggunakan [awsu](https://github.com/kreuzwerker/awsu) profil dibaca dar
Ketika menggunakan [AWSume](https://awsu.me) profil dibaca dari variabel environment `AWSUME_PROFILE` dan tanggal kedaluwarsanya dibaca dari variabel environment `AWSUME_EXPIRATION`.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `fromat` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Format dari modul. |
-| `symbol` | `"☁️ "` | Simbol yang digunakan sebelum menampilkan profil AWS terkini. |
-| `region_aliases` | | Tabel alias dari region yang ditampilan selain nama AWS. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | Gaya penataan untuk modul. |
+| `symbol` | `'☁️ '` | Simbol yang digunakan sebelum menampilkan profil AWS terkini. |
+| `region_aliases` | `{}` | Tabel alias dari region yang ditampilan selain nama AWS. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | Gaya penataan untuk modul. |
| `expiration_symbol` | `X` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. |
| `disabled` | `false` | Menonaktifkan modul `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ Ketika menggunakan [AWSume](https://awsu.me) profil dibaca dari variabel environ
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Menampilkan profil
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Opsi
| Variabel | Bawaan | Deskripsi |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `fromat` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `fromat` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
### Contoh
+#### Display Subscription Name
+
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ Modul `battery` menampilkan seberapa penuh baterai perangkat terisi dan status p
| Opsi | Bawaan | Deskripsi |
| -------------------- | --------------------------------- | --------------------------------------------------------- |
-| `full_symbol` | `" "` | Simbol dimunculkan ketika baterai penuh. |
-| `charging_symbol` | `" "` | Simbol dimunculkan ketika baterai mengisi. |
-| `discharging_symbol` | `" "` | Simbol dimunculkan ketika baterai terpakai. |
-| `unknown_symbol` | `" "` | Simbol dimunculkan ketika keadaan baterai tidak dikenali. |
-| `empty_symbol` | `" "` | Simbol dimunculkan ketika keadaan baterai kosong. |
-| `fromat` | `"[$symbol$percentage]($style) "` | Format dari modul. |
+| `full_symbol` | `' '` | Simbol dimunculkan ketika baterai penuh. |
+| `charging_symbol` | `' '` | Simbol dimunculkan ketika baterai mengisi. |
+| `discharging_symbol` | `' '` | Simbol dimunculkan ketika baterai terpakai. |
+| `unknown_symbol` | `' '` | Simbol dimunculkan ketika keadaan baterai tidak dikenali. |
+| `empty_symbol` | `' '` | Simbol dimunculkan ketika keadaan baterai kosong. |
+| `fromat` | `'[$symbol$percentage]($style) '` | Format dari modul. |
| `display` | [link](#battery-display) | Menampilkan ambang dan gaya dari modul. |
| `disabled` | `false` | Menonaktifkan modul `baterai`. |
@@ -423,9 +478,9 @@ Modul `battery` menampilkan seberapa penuh baterai perangkat terisi dan status p
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Tampilan Baterai
@@ -435,7 +490,7 @@ Opsi konfigurasi `display` digunakan untuk menentukan kapan indikator baterai ha
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
Nilai bawaan untuk opsi `charging_symbol` dan `discharging_symbol` adalah nilai dari masing-masing opsi `charging_symbol` dan `discharging_symbol` dari nilai `battery`.
@@ -447,21 +502,21 @@ Opsi dari `display` merupakan sebuah array dari tabel berikut.
| Opsi | Bawaan | Deskripsi |
| -------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `style` | `"red bold"` | The style used if the display option is in use. |
+| `style` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Simbol opsional ditampilan jika opsi tampilan sedang digunakan, bawaan untuk opsi `charging_symbol` dari baterai. |
| `discharging_symbol` | | Simbol opsional ditampilan jika opsi tampilan sedang digunakan, bawaan untuk opsi `discharging_symbol` dari baterai. |
#### Contoh
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Opsi | Bawaan | Deskripsi |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `fromat` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | Format dari versi. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `fromat` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | Format dari versi. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | filenames mana yang sebaiknya memicu modul ini. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
-| `style` | `"bold blue"` | Gaya penataan untuk modul. |
+| `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Menonaktifkan modul `elixir`. |
### Variabel
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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` | `"🍞 "` | A format string representing the symbol of Node.js. |
+| `fromat` | `'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 Bun. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | filenames mana yang sebaiknya memicu modul ini. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
-| `style` | `"bold red"` | Gaya penataan untuk modul. |
+| `style` | `'bold red'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `bun` module. |
### Variabel
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Opsi | Bawaan | Deskripsi |
| ------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `fromat` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
+| `fromat` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | 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. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | Gaya penataan untuk modul. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `c` module. |
### Variabel
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Karakter
@@ -611,13 +666,13 @@ Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin menggan
| Opsi | Bawaan | Deskripsi |
| --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------- |
-| `fromat` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. |
-| `success_symbol` | `"[❯](bold green)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil. |
-| `error_symbol` | `"[❯](bold red)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `fromat` | `'$symbol '` | Format string yang digunakan sebelum masukan teks. |
+| `success_symbol` | `'[❯](bold green)'` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil. |
+| `error_symbol` | `'[❯](bold red)'` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Menonaktifkan module `character`. |
### Variabel
@@ -634,8 +689,8 @@ Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin menggan
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Tanpa menggunakan corak eror yang dikustomisasi
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### Dengan menggunakan corak vim yang dikustomisasi
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ Modul `cmake` menampilkan versi terkini dari [CMake](https://cmake.org/) yang te
| 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` | `"△ "` | Simbol yang digunakan sebelum versi cmake. |
+| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
+| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'△ '` | Simbol yang digunakan sebelum versi cmake. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | filenames mana yang sebaiknya memicu modul ini |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | filenames mana yang sebaiknya memicu modul ini |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini |
-| `style` | `"bold blue"` | Gaya penataan untuk modul. |
+| `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Menonaktifkan modul `cmake`. |
### Variabel
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. |
-| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | Gaya penataan untuk modul. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
+| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | Gaya penataan untuk modul. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | 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 `cobol` module. |
@@ -735,8 +790,8 @@ Pengguna Bash yang membutuhkan fungsi seperti preexec dapat menggunakan [kerangk
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_tim` | `2_000` | Durasi terpendek untuk menampilkan waktu (dalam milidetik). |
| `show_milliseconds` | `false` | Tampilkan milidetik sebagai ganti detik untuk durasinya. |
-| `fromat` | `"took [$duration]($style) "` | Format dari modul. |
-| `style` | `"bold yellow"` | Gaya penataan untuk modul. |
+| `fromat` | `'took [$duration]($style) '` | Format dari modul. |
+| `style` | `'bold yellow'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Menonaktifkan modul `cmd_duration`. |
| `show_notifications` | `false` | Menampilkan notifikasi layar ketika perintah selesai. |
| `min_time_to_notify` | `45_000` | Durasi terpendek untuk menampilkan notifikasi (dalam milidetik). |
@@ -758,7 +813,7 @@ Pengguna Bash yang membutuhkan fungsi seperti preexec dapat menggunakan [kerangk
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungki
| Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | Jumlah direktori yang dipotong oleh environment path, jika environment-nya dibuat melalui `conda create -p [path]`. `0` artinya tidak ada potongan. Lihat juga modul [`directory`](#directory). |
-| `symbol` | `"🅒 "` | Simbol yang digunakan sebelum nama environment. |
-| `style` | `"bold green"` | Gaya penataan untuk modul. |
-| `fromat` | `"via [$symbol$environment]($style) "` | Format dari modul. |
+| `symbol` | `'🅒 '` | Simbol yang digunakan sebelum nama environment. |
+| `style` | `'bold green'` | Gaya penataan untuk modul. |
+| `fromat` | `'via [$symbol$environment]($style) '` | Format dari modul. |
| `ignore_base` | `true` | Mengabaikan `base` environment saat aktif. |
| `disabled` | `false` | Menonaktifkan modul `conda`. |
@@ -798,7 +853,7 @@ Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungki
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Opsi | Bawaan | Deskripsi |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | Gaya penataan untuk modul. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | Gaya penataan untuk modul. |
| `fromat` | `'[$symbol \[$name\]]($style) '` | Format dari modul. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ Modul `crystal` menampilkan versi terkini dari [Crystal](https://crystal-lang.or
| Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | Simbol yang digunakan sebelum menampilkan versi crystal terkini. |
-| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. |
-| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | Gaya penataan untuk modul. |
-| `detect_extensions` | `["cr"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
-| `detect_files` | `["shard.yml"]` | filenames mana yang sebaiknya memicu modul ini. |
+| `symbol` | `'🔮 '` | Simbol yang digunakan sebelum menampilkan versi crystal terkini. |
+| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
+| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | Gaya penataan untuk modul. |
+| `detect_extensions` | `['cr']` | Ekstensi mana yang sebaiknya memicu modul ini. |
+| `detect_files` | `['shard.yml']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `disabled` | `false` | Menonaktifkan modul `crystal`. |
@@ -869,7 +924,7 @@ Modul `crystal` menampilkan versi terkini dari [Crystal](https://crystal-lang.or
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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` | `"Λ "` | A format string representing the symbol of Daml |
-| `style` | `"bold cyan"` | Gaya penataan untuk modul. |
+| `fromat` | `'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 Daml |
+| `style` | `'bold cyan'` | Gaya penataan untuk modul. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
-| `detect_files` | `["daml.yaml"]` | filenames mana yang sebaiknya memicu modul ini. |
+| `detect_files` | `['daml.yaml']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ Modul `dart` menampilkan versi terkini dari [Dart](https://dart.dev/) yang terpa
| 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` | `"🎯 "` | Sebuah format string yang melambangkan simbol Dart |
-| `detect_extensions` | `["dart"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | filenames mana yang sebaiknya memicu modul ini. |
-| `detect_folders` | `[".dart_tool"]` | Folder mana yang sebaiknya memicul modul ini. |
-| `style` | `"bold blue"` | Gaya penataan untuk modul. |
+| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
+| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | Sebuah format string yang melambangkan simbol Dart |
+| `detect_extensions` | `['dart']` | Ekstensi mana yang sebaiknya memicu modul ini. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | filenames mana yang sebaiknya memicu modul ini. |
+| `detect_folders` | `['.dart_tool']` | Folder mana yang sebaiknya memicul modul ini. |
+| `style` | `'bold blue'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Menonaktifkan modul `dart`. |
### Variabel
@@ -947,7 +1002,7 @@ Modul `dart` menampilkan versi terkini dari [Dart](https://dart.dev/) yang terpa
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ Modul `deno` menampilkan versi terkini dari [Deno](https://deno.land/) yang terp
| 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` | `🦕 "` | Sebuah format string yang melambangkan simbol Deno |
+| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
+| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🦕 '` | Sebuah format string yang melambangkan simbol Deno |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | filenames mana yang sebaiknya memicu modul ini. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
-| `style` | `"green bold"` | Gaya penataan untuk modul. |
+| `style` | `'green bold'` | Gaya penataan untuk modul. |
| `disabled` | `false` | Menonaktifkan modul `deno`. |
### Variabel
@@ -983,7 +1038,7 @@ Modul `deno` menampilkan versi terkini dari [Deno](https://deno.land/) yang terp
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Direktori
@@ -996,20 +1051,21 @@ Sebagai contoh, untuk `~/Dev/Nix/nixpkgs/pkgs` dimana `nixpkgs` merupakan root r
### Opsi
-| Opsi | Bawaan | Deskripsi |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | Jumlah dari folder induk yang harusnya disingkat oleh direktori saat ini. |
-| `truncate_to_repo` | `true` | Apakah harus menyingkat root dari git repo tempatmu berada saat ini. |
-| `fromat` | `"[$path]($style)[$read_only]($read_only_style) "` | Format dari modul. |
-| `style` | `"bold cyan"` | Gaya penataan untuk modul. |
-| `disabled` | `false` | Menonaktifkan modul `directory`. |
-| `read_only` | `"🔒"` | Simbol yang mengindikasikan direktori saat ini bersifat read only. |
-| `read_only_style` | `"red"` | Corak gaya untuk simbol read only. |
-| `truncation_symbol` | `""` | Simbol untuk awalan jalur yang disingkat. misalnya: ".../" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | Simbol yang mengindikasikan direktori home. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Opsi | Bawaan | Deskripsi |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | Jumlah dari folder induk yang harusnya disingkat oleh direktori saat ini. |
+| `truncate_to_repo` | `true` | Apakah harus menyingkat root dari git repo tempatmu berada saat ini. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | Format dari modul. |
+| `style` | `'bold cyan'` | Gaya penataan untuk modul. |
+| `disabled` | `false` | Menonaktifkan modul `directory`. |
+| `read_only` | `'🔒'` | Simbol yang mengindikasikan direktori saat ini bersifat read only. |
+| `read_only_style` | `'red'` | Corak gaya untuk simbol read only. |
+| `truncation_symbol` | `''` | Simbol untuk awalan jalur yang disingkat. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | Simbol yang mengindikasikan direktori home. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
Modul ini memilki beberapa opsi konfigurasi lanjutan yang mengontrol bagaimana direktori ditampilkan.
@@ -1024,8 +1080,8 @@ Sebagai contoh, untuk `~/Dev/Nix/nixpkgs/pkgs` dimana `nixpkgs` merupakan root r
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ Sebagai contoh, untuk `~/Dev/Nix/nixpkgs/pkgs` dimana `nixpkgs` merupakan root r
| Variabel | Contoh | Deskripsi |
| --------- | --------------------- | -------------------------------- |
-| path | `"D:/Projects"` | Direktori terkini |
-| style\* | `"black bold dimmed"` | Menyalin nilai dari opsi `style` |
+| path | `'D:/Projects'` | Direktori terkini |
+| style\* | `'black bold dimmed'` | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Variabel | Contoh | Deskripsi |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Menyalin nilai dari opsi `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Menyalin nilai dari opsi `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Please check out these previous works that helped inspire the creation of starsh
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/id-ID/presets/README.md b/docs/id-ID/presets/README.md
index 5d7631b08..838e08db9 100644
--- a/docs/id-ID/presets/README.md
+++ b/docs/id-ID/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Segmen Berkurung](./bracketed-segments.md)
Konfigurasi prasetel berikut mengubah format dari seluruh modul bawaan untuk menampilkan segmennya di dalam tanda kurung daripada menggunakan susunan kata bawaan Starship ("via", "on", dll.).
@@ -28,6 +36,12 @@ Konfigurasi prasetel berikut menyembunyikan versi language runtimes. Jika kamu b
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/id-ID/presets/no-empty-icons.md b/docs/id-ID/presets/no-empty-icons.md
new file mode 100644
index 000000000..72d3f7a25
--- /dev/null
+++ b/docs/id-ID/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Konfigurasi
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/id-ID/presets/no-nerd-font.md b/docs/id-ID/presets/no-nerd-font.md
new file mode 100644
index 000000000..d12907261
--- /dev/null
+++ b/docs/id-ID/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Konfigurasi
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/id-ID/presets/tokyo-night.md b/docs/id-ID/presets/tokyo-night.md
new file mode 100644
index 000000000..d1f3aebfc
--- /dev/null
+++ b/docs/id-ID/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Prasyarat
+
+- [Nerd Font](https://www.nerdfonts.com/) yang sudah terpasang dan berjalan di dalam terminalmu
+
+### Konfigurasi
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md
index 476651d6d..671b2f303 100644
--- a/docs/it-IT/advanced-config/README.md
+++ b/docs/it-IT/advanced-config/README.md
@@ -8,11 +8,11 @@ Le configurazioni in questa sezione sono soggette a modifiche nelle future versi
:::
-## TransientPrompt in PowerShell
+## TransientPrompt su PowerShell
-It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put this statement in your `$PROFILE`. Transience can be disabled on-the-fly with `Disable-TransientPrompt`.
+È 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 `Enable-TransientPrompt` sulla shell. Per mantenerlo permanente, metti questa dichiarazione nel tuo `$PROFILE`. Può essere disattivata al volo con `Disable-TransientPrompt`.
-By default, the left side of input gets replaced with `>`. To customize this, define a new function called `Invoke-Starship-TransientFunction`. For example, to display Starship's `character` module here, you would do
+Per impostazione predefinita, il simbolo predefinito prima dell'input sarà rimpiazzato con `>`. Per personalizzarlo, definisci una nuova funzione chiamata `Invoke-Starship-TransientFunction`. Ad esempio, per mostrare il modulo dei `character`, dovresti fare
```powershell
function Invoke-Starship-TransientFunction {
@@ -26,7 +26,7 @@ Enable-TransientPrompt
## TransientPrompt and TransientRightPrompt in Cmd
-Clink allows you to replace the previous-printed prompt with custom strings. This is useful in cases where all the prompt information is not always needed. To enable this, run `clink set prompt.transient This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Variable | Esempio | Descrizione |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Variable | Esempio | Descrizione |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Ti invito di controllare questi lavori precedenti che hanno contribuito a ispira
- **[reujab/silver](https://github.com/reujab/silver)** – Un prompt multi-shell personalizzabile come powerline con icone.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/it-IT/presets/README.md b/docs/it-IT/presets/README.md
index b09df057a..2b2150737 100644
--- a/docs/it-IT/presets/README.md
+++ b/docs/it-IT/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/it-IT/presets/no-empty-icons.md b/docs/it-IT/presets/no-empty-icons.md
new file mode 100644
index 000000000..bdcb67d11
--- /dev/null
+++ b/docs/it-IT/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configurazione
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/it-IT/presets/no-nerd-font.md b/docs/it-IT/presets/no-nerd-font.md
new file mode 100644
index 000000000..5656e8e15
--- /dev/null
+++ b/docs/it-IT/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configurazione
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/it-IT/presets/tokyo-night.md b/docs/it-IT/presets/tokyo-night.md
new file mode 100644
index 000000000..f405fa7fa
--- /dev/null
+++ b/docs/it-IT/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Prerequisiti
+
+- Un [ Nerd Font ](https://www.nerdfonts.com/) installato e abilitato nel tuo terminale
+
+### Configurazione
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md
index d75cc5731..9fd27087c 100644
--- a/docs/ja-JP/README.md
+++ b/docs/ja-JP/README.md
@@ -4,14 +4,14 @@ heroImage: /logo.svg
heroText:
tagline: シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです！
actionText: Get Started →
-actionLink: ./guide/
+actionLink: ./ja-JP/guide/
features:
-
title: 互換性優先
details: 一般的なほとんどのOSの一般的なほとんどのシェル上で動作します。 あらゆるところで使用してください！
-
- title: Rust 製
- details: Rust の最高レベルの速度と安全性を用いることで、可能な限り高速かつ信頼性を高くしています。
+ title: Rust製
+ details: Rustの最高レベルの速度と安全性を用いることで、可能な限り高速かつ信頼性を高くしています。
-
title: カスタマイズ可能
details: それぞれの細かい点は好みにカスタマイズが出来るため、ミニマルにも多機能にも好きなようにプロンプトを設定することができます。
diff --git a/docs/ja-JP/advanced-config/README.md b/docs/ja-JP/advanced-config/README.md
index 81ced6a95..4669b10b8 100644
--- a/docs/ja-JP/advanced-config/README.md
+++ b/docs/ja-JP/advanced-config/README.md
@@ -205,7 +205,9 @@ Invoke-Expression (&starship init powershell)
注意: 右プロンプトは入力の場所に続く単一の行です。 To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
+
+Note: Nushell 0.71.0 or later is required
### 設定例
@@ -280,5 +282,5 @@ continuation_prompt = "▶▶"
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md
index 05d7b11c5..05df16c0e 100644
--- a/docs/ja-JP/config/README.md
+++ b/docs/ja-JP/config/README.md
@@ -9,20 +9,23 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。
```toml
-# エディターの補完を設定スキーマに合わせて取得
+# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'
-# シェルのプロンプトの間に空行を挿入する
+# Inserts a blank line between shell prompts
add_newline = true
-# 記号"❯"を記号"➜"に置き換える
-[character] # 編集するモジュールの名前は"character"
-success_symbol = "[➜](bold green)" # "success_symbol"を記号"➜"で"bold green"(太字の緑色)にセット
-# パッケージモジュールを無効化することでプロンプトを完全に非表示にする
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
+
+# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
`STARSHIP_CONFIG` 環境変数を使用することによって、デフォルトの設定ファイルの場所を変更できます。
```sh
@@ -69,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
慣例により、ほとんどのモジュールにはデフォルトの端末色の接頭辞（「nodejs」の`via` など）と接尾辞として空のスペースがあります。
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+例：
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### 文字列のフォーマット
文字列の書式は、モジュールがすべての変数を出力する書式です。 ほとんどのモジュールには、モジュールの表示形式を設定する `format` というエントリがあります。 テキスト、変数、およびテキストグループをフォーマット文字列で使用できます。
@@ -79,9 +138,9 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
例：
-- `$version` は、`version` という名前の変数を持つフォーマット文字列です。
-- `$git_branch$git_commit` は `git_branch` と `git_commit` という2つの変数を持つフォーマット文字列です。
-- `$git_branch $git_commit` には空白で区切られた 2 つの変数があります。
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### テキストグループ
@@ -93,22 +152,22 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
例：
-- `[on](red bold)` は文字列 `on` に太字のテキストを赤色で表示します。
-- `[⌘ $version](bold green)` は `⌘` 記号とその後に続く変数 `version` の値を、太字の緑色で表示します。
-- `[a [b](red) c](green)` は `a b c` を `b` だけ赤色に表示し、 `a` と `c` を緑色に表示します。
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### スタイルの設定
Starshipのほとんどのモジュールでは、表示スタイルを設定できます。 これは、設定を指定する文字列であるエントリ（`style`）で行われます。 スタイル文字列の例とその機能を次に示します。 完全な構文の詳細については、詳細は [高度な設定](/advanced-config/)を参照してください 。
-- `"fg:green bg:blue"` は、青色の背景に緑色のテキストを設定します
-- `"bg:blue fg:bright-green"` は、青色の背景に明るい緑色のテキストを設定します
-- `"bold fg:27"` は、 [ANSIカラー](https://i.stack.imgur.com/KTSQa.png) 27の太字テキストを設定します
-- `"underline bg:#bf5700"` は、焦げたオレンジ色の背景に下線付きのテキストを設定します
-- `"bold italic fg:purple"`は、紫色の太字斜体のテキストを設定します
-- `""` はすべてのスタイルを明示的に無効にします
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
-スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。 たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。 また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。
+スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。 たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。 また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。
#### 条件付きフォーマット設定
@@ -116,43 +175,20 @@ Starshipのほとんどのモジュールでは、表示スタイルを設定で
例：
-- `(@$region)` は`region`が`None`または空だった場合表示されませんが、値がある場合は`@` に続いてregionの値が表示されます。
-- `(some text)` は括弧の中に変数がないので、常に何も表示しません。
-- `$all` が `\[$a$b\]` のショートカットである時、 `$a` と `$b` が両方とも `None` である場合に限り、`($all)` は何も表示しません。 これは `(\[$a$b\] )` と同じ動作をします。
-
-#### 特殊文字
-
-次の記号はフォーマット文字列で特殊な用途を持っているため、エスケープする必要があります。: `$ \ [ ] ( )`.
-
-TOMLには、 [基本文字列とリテラル文字列](https://toml.io/en/v1.0.0#string)の両方があることに注意してください。 設定では、リテラル文字列(シングルクォートで囲まれた文字列)を使用することをお勧めします。基本文字列(ダブルクォートで囲まれた文字列)を使用したい場合は、バックスラッシュ自体をエスケープする必要があります。(例: `\\`を使用する)
-
-例えば、新しい行に `$` 記号を表示したい場合、以下の `format` の設定が等価です。
-
-```toml
-# 基本文字列と
-format = "\n\\$"
-
-# 複数行の基本文字列と
-format = """
-
-\\$"""
-
-# リテラル文字列と
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## プロンプト
@@ -164,11 +200,11 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
| オプション | デフォルト | 説明 |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 |
-| `right_format` | `""` | [右プロンプトの有効化](/advanced-config/#enable-right-prompt)を参照してください。 |
+| `right_format` | `''` | [右プロンプトの有効化](/advanced-config/#enable-right-prompt)を参照してください。 |
| `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 |
| `command_timeout` | `500` | Starshipによって実行されたコマンドのタイムアウト時間 (milliseconds) です。 |
| `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### 設定例
@@ -176,28 +212,27 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
```toml
# ~/.config/starship.toml
-# カスタムフォーマットを利用します
-format = """
+# Use custom format
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
-
-# starshipが現在のディレクトリ下のファイルをチェックするまで10ミリ秒待ちます
+[└─>](bold green) '''
+# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### デフォルトのプロンプトフォーマット
@@ -205,7 +240,7 @@ mustard = "#af8700"
デフォルトの `format` は、空または `format` が指定されていない場合、プロンプトのフォーマットを定義するために使用されます。 デフォルトは次のとおりです。
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -289,8 +328,8 @@ $character"""
デフォルトのフォーマットを拡張したいだけなら、`$all`を使用できます。 フォーマットに明示的に追加したモジュールは重複しません。 例:
```toml
-# ディレクトリを2行目に移動
-format = "$all$directory$character"
+# Move the directory to the second line
+format = '$all$directory$character'
```
## AWS
@@ -305,28 +344,30 @@ format = "$all$directory$character"
[AWSume](https://awsu.me)を使う場合、環境変数`AWSUME_PROFILE`からプロファイルが、環境変数`AWSUME_EXPIRATION`から資格情報の有効期限が読み込まれます。
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### オプション
| オプション | デフォルト | 説明 |
| ------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | module のフォーマットです。 |
-| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
-| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 |
-| `profile_aliases` | | AWS名に加えて表示するプロファイルのエイリアスです。 |
-| `style` | `"bold yellow"` | モジュールのスタイルです。 |
+| `symbol` | `'☁️ '` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
+| `region_aliases` | `{}` | AWS名に加えて表示するリージョンのエイリアスです。 |
+| `profile_aliases` | `{}` | AWS名に加えて表示するプロファイルのエイリアスです。 |
+| `style` | `'bold yellow'` | モジュールのスタイルです。 |
| `expiration_symbol` | `X` | この記号は一時的な資格情報が有効期限切れの場合に表示されます。 |
| `disabled` | `false` | `aws`モジュールを無効にします。 |
| `force_display` | `false` | `true`の場合、`credentials`、`credential_process`または`sso_start_url`が設定されていない場合でも情報を表示します。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | ---------------- | ---------------------- |
-| region | `ap-northeast-1` | 現在のAWSリージョン |
-| profile | `astronauts` | 現在のAWSプロファイル |
-| duration | `2h27m20s` | 一時的な資格情報の有効期限 |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | ---------------- | ----------------------- |
+| region | `ap-northeast-1` | 現在のAWSリージョン |
+| profile | `astronauts` | 現在のAWSプロファイル |
+| duration | `2h27m20s` | 一時的な資格情報の有効期限 |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -335,13 +376,15 @@ format = "$all$directory$character"
#### すべてを表示
```toml
+# ~/.config/starship.toml
+
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -352,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### プロファイルを表示
@@ -366,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-`azure` モジュールは、現在のAzureサブスクリプションを表示します。 これは、 `~/.azure/azureProfile.json` ファイルで定義されているデフォルトのサブスクリプションの名前の表示に基づいています。
+`azure` モジュールは、現在のAzureサブスクリプションを表示します。 これは、 `~/.azure/azureProfile.json` ファイルで定義されているデフォルトのサブスクリプション名またはユーザー名の表示に基づいています。
### オプション
| 変数 | デフォルト | 説明 |
| ---------- | ---------------------------------------- | ----------------------- |
-| `format` | `"on [$symbol($subscription)]($style) "` | Azure module のフォーマットです。 |
-| `symbol` | `"ﴃ "` | フォーマットで使用される記号です。 |
-| `style` | `"blue bold"` | フォーマットで使用されるスタイルです。 |
+| `format` | `'on [$symbol($subscription)]($style) '` | Azure module のフォーマットです。 |
+| `symbol` | `'ﴃ '` | フォーマットで使用される記号です。 |
+| `style` | `'blue bold'` | フォーマットで使用されるスタイルです。 |
| `disabled` | `true` | `azure`モジュールを無効にします。 |
### 設定例
+#### サブスクリプション名を表示
+
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### ユーザー名を表示
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -406,12 +463,12 @@ style = "blue bold"
| オプション | デフォルト | 説明 |
| -------------------- | --------------------------------- | ------------------------- |
-| `full_symbol` | `" "` | バッテリーが満タンのときに表示される記号です。 |
-| `charging_symbol` | `" "` | バッテリーの充電中に表示される記号です。 |
-| `discharging_symbol` | `" "` | バッテリーが放電しているときに表示される記号です。 |
-| `unknown_symbol` | `" "` | バッテリー状態が不明なときに表示される記号です。 |
-| `empty_symbol` | `" "` | バッテリーが空のときに表示される記号です。 |
-| `format` | `"[$symbol$percentage]($style) "` | moduleのフォーマットです。 |
+| `full_symbol` | `' '` | バッテリーが満タンのときに表示される記号です。 |
+| `charging_symbol` | `' '` | バッテリーの充電中に表示される記号です。 |
+| `discharging_symbol` | `' '` | バッテリーが放電しているときに表示される記号です。 |
+| `unknown_symbol` | `' '` | バッテリー状態が不明なときに表示される記号です。 |
+| `empty_symbol` | `' '` | バッテリーが空のときに表示される記号です。 |
+| `format` | `'[$symbol$percentage]($style) '` | module のフォーマットです。 |
| `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 |
| `disabled` | `false` | `battery`モジュールを無効にします。 |
@@ -421,9 +478,9 @@ style = "blue bold"
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### バッテリーの表示
@@ -433,7 +490,7 @@ discharging_symbol = "💀 "
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
`charging_symbol`と`discharging_symbol`オプションのデフォルト値はそれぞれ`battery`の `charging_symbol`と`discharging_symbol`になります。
@@ -445,23 +502,23 @@ style = "bold red"
| オプション | デフォルト | 説明 |
| -------------------- | ------------ | -------------------------------------------------------------------------------------- |
| `threshold` | `10` | バッテリーが表示される上限です。 |
-| `style` | `"red bold"` | displayオプションが使用されている場合のスタイルです。 |
+| `style` | `'red bold'` | displayオプションが使用されている場合のスタイルです。 |
| `charging_symbol` | | displayオプションが使用されている場合はこののシンボルが表示されます。デフォルトはバッテリーの `charging_symbol` オプションと同じになります。 |
| `discharging_symbol` | | displayオプションが使用されている場合はこののシンボルが表示されます。デフォルトはバッテリーの `discharging_symbol` オプションと同じになります。 |
#### 設定例
```toml
-[[battery.display]] # "bold red"(太字の赤)でdischarging_symbolをバッテーリー残量が0%から10%の間で表示
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow"(太字の黄)で記号💦をバッテリー残量が10%から30%の間で表示
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
-# バッテリー残量が30%を超えると、バッテリーインジケータは表示されません
+# when capacity is over 30%, the battery indicator will not be displayed
```
## Buf
@@ -475,22 +532,22 @@ discharging_symbol = "💦"
| オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------- | -------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | `buf`モジュールの形式。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 |
-| `symbol` | `"🦬 "` | Bufのバージョンを表示する前に使用される記号です。 |
+| `format` | `'with [$symbol($version )]($style)'` | `buf`モジュールの形式。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 |
+| `symbol` | `'🦬 '` | Bufのバージョンを表示する前に使用される記号です。 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | どのファイル名がこのモジュールをアクティブにするか |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
-| `style` | `"bold blue"` | モジュールのスタイルです。 |
+| `style` | `'bold blue'` | モジュールのスタイルです。 |
| `disabled` | `false` | `elixir`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | -------- | ---------------------- |
-| `version` | `v1.0.0` | `buf`のバージョン |
-| `symbol` | | オプション `記号` の値をミラーする |
-| `style`* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | -------- | ----------------------- |
+| `version` | `v1.0.0` | `buf`のバージョン |
+| `symbol` | | オプション `symbol` の値をミラーする |
+| `style`* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -500,7 +557,7 @@ discharging_symbol = "💦"
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -514,22 +571,22 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `symbol` | `"🍞 "` | A format string representing the symbol of Node.js. |
+| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | どのファイル名がこのモジュールをアクティブにするか |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
-| `style` | `"bold red"` | モジュールのスタイルです。 |
+| `style` | `'bold red'` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `bun` module. |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | -------- | ---------------------- |
-| version | `v0.1.4` | The version of `bun` |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | -------- | ----------------------- |
+| version | `v0.1.4` | The version of `bun` |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -539,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -550,24 +607,24 @@ format = "via [🍔 $version](bold green) "
| オプション | デフォルト | 説明 |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------ |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | モジュールのフォーマット文字列。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `symbol` | `"C "` | コンパイラの詳細を表示する前に使用される記号です。 |
-| `detect_extensions` | `["c", "h"]` | どの拡張子がこのモジュールをアクティブにするか |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | モジュールのフォーマット文字列。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `symbol` | `'C '` | コンパイラの詳細を表示する前に使用される記号です。 |
+| `detect_extensions` | `['c', 'h']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | コンパイラを検出する方法 |
-| `style` | `"bold 149"` | モジュールのスタイルです。 |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | コンパイラを検出する方法 |
+| `style` | `'bold 149'` | モジュールのスタイルです。 |
| `disabled` | `false` | `c`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| ------- | ------ | ---------------------- |
-| name | clang | コンパイラ名 |
-| version | 13.0.0 | コンパイラのバージョン |
-| symbol | | オプション `記号` の値をミラーする |
-| style | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| ------- | ------ | ----------------------- |
+| name | clang | コンパイラ名 |
+| version | 13.0.0 | コンパイラのバージョン |
+| symbol | | オプション `symbol` の値をミラーする |
+| style | | オプション `style` の値をミラーする |
`version`はデフォルトのフォーマットではないことに注意してください。
@@ -575,7 +632,7 @@ format = "via [🍔 $version](bold green) "
`commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。
-各コマンドは、実行可能ファイル名の後に引数を続けるリストとして表されます。通常は`["mycc", "--version"]`のようになります。 StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。
もし、Cコンパイラがこのモジュールでサポートされていない場合は、[GitHubで問題を提起する](https://github.com/starship/starship/)ことでリクエストできます。
@@ -585,14 +642,14 @@ format = "via [🍔 $version](bold green) "
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## 文字
`character`モジュールは、端末でテキストが入力される場所の横に文字（通常は矢印）を表示します。
-文字は、最後のコマンドが成功したかどうかを示します。 表し方は下記の2つです。
+characterは、最後のコマンドが成功したかどうかを示します。 表し方は下記の2つです。
- 色の変更 (`赤`/`緑`)
- プロンプトの表示の変更 (`❯`/`✖`)
@@ -607,16 +664,16 @@ format = "via [$name $version]($style)"
### オプション
-| オプション | デフォルト | 説明 |
-| --------------------------- | -------------------- | ------------------------------------------------------ |
-| `format` | `"$symbol"` | テキスト入力の前に使用される書式文字列。 |
-| `success_symbol` | `"[❯](bold green)"` | 前のコマンドが成功した場合にテキスト入力の前に使用される書式文字列です。 |
-| `error_symbol` | `"[❯](bold red)"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される書式文字列です。 |
-| `vimcmd_symbol` | `"[❮](bold green)"` | シェルが vim ノーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列。 |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | シェルがvimの`replace_one`モードの場合にテキスト入力の前に使用されるフォーマット文字列です。 |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | シェルがvimの置換モードの場合にテキスト入力の前に使用されるフォーマット文字列。 |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | シェルがvimの置換モードの場合にテキスト入力の前に使用されるフォーマット文字列。 |
-| `disabled` | `false` | `character`モジュールを無効にします。 |
+| オプション | デフォルト | 説明 |
+| --------------------------- | -------------------- | -------------------------------------------------------------------------------- |
+| `format` | `'$symbol '` | テキスト入力の前に使用されるフォーマット文字列。 |
+| `success_symbol` | `'[❯](bold green)'` | 前のコマンドが成功した場合にテキスト入力の前に使用されるフォーマット文字列です。 |
+| `error_symbol` | `'[❯](bold red)'` | 前のコマンドが失敗した場合にテキスト入力の前に使用されるフォーマット文字列です。 |
+| `vimcmd_symbol` | `'[❮](bold green)'` | シェルがvimノーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列です。 |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | シェルがvimの`replace_one`モードの場合にテキスト入力の前に使用されるフォーマット文字列です。 |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | シェルがvimの置換モードの場合にテキスト入力の前に使用されるフォーマット文字列。 |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
+| `disabled` | `false` | `character`モジュールを無効にします。 |
### 変数
@@ -632,8 +689,8 @@ format = "via [$name $version]($style)"
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### エラーの形状をカスタムしない
@@ -642,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### vimの形状をカスタムする
@@ -652,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -666,22 +723,22 @@ vicmd_symbol = "[V](bold green) "
| オプション | デフォルト | 説明 |
| ------------------- | -------------------------------------- | ------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `symbol` | `"△ "` | cmakeのバージョンの前に使用される記号 |
+| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `symbol` | `'△ '` | cmakeのバージョンの前に使用される記号 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | どのファイル名がこのモジュールをアクティブにするか |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
-| `style` | `"bold blue"` | モジュールのスタイルです。 |
+| `style` | `'bold blue'` | モジュールのスタイルです。 |
| `disabled` | `false` | `cmake`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | --------- | ---------------------- |
-| version | `v3.17.3` | cmake のバージョン |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | --------- | ----------------------- |
+| version | `v3.17.3` | cmake のバージョン |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -696,22 +753,22 @@ vicmd_symbol = "[V](bold green) "
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
-| `symbol` | `"⚙️ "` | COBOLのバージョンを表示する前に使用される記号です。 |
-| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `style` | `"bold blue"` | モジュールのスタイルです。 |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | どの拡張子がこのモジュールをアクティブにするか |
+| `symbol` | `'⚙️ '` | COBOLのバージョンを表示する前に使用される記号です。 |
+| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `style` | `'bold blue'` | モジュールのスタイルです。 |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | `cobol`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | ---------- | ---------------------- |
-| version | `v3.1.2.0` | `cobol`のバージョン |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | ---------- | ----------------------- |
+| version | `v3.1.2.0` | `cobol`のバージョン |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -733,11 +790,11 @@ preexecのような機能を必要とするBashユーザーは、 [rcalorasのba
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 |
| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 |
-| `format` | `"took [$duration]($style) "` | module のフォーマットです。 |
-| `style` | `"bold yellow"` | モジュールのスタイルです。 |
+| `format` | `'took [$duration]($style) '` | module のフォーマットです。 |
+| `style` | `'bold yellow'` | モジュールのスタイルです。 |
| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 |
| `show_notifications` | `false` | コマンドが完了したらデスクトップ通知を表示します。 |
-| `min_time_to_notify` | `45_000` | 通知を持続する最短期間(ミリ秒単位) |
+| `min_time_to_notify` | `45_000` | 通知を持続する最短期間 (ミリ秒単位) です。 |
| `notification_timeout` | | 通知を表示する期間 (ミリ秒単位) です。 もし設定されていない場合、通知のタイムアウトはデーモンによって決定されます。 すべての通知デーモンがこのオプションを受け入れるわけではありません。 |
### 変数
@@ -756,7 +813,7 @@ preexecのような機能を必要とするBashユーザーは、 [rcalorasのba
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -774,19 +831,19 @@ Note: これはconda自身の プロンプト修飾子 を抑制しません。`
| オプション | デフォルト | 説明 |
| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | 環境が`conda create -p [path]`で作成された場合、環境パスが切り捨てられるディレクトリ数。 `0`は切り捨てがないことを意味します。 [`directory`](#directory)もご覧ください。 |
-| `symbol` | `"🅒 "` | 環境名の直前に使用されるシンボルです。 |
-| `style` | `"bold green"` | モジュールのスタイルです。 |
-| `format` | `"via [$symbol$environment]($style) "` | module のフォーマットです。 |
+| `symbol` | `'🅒 '` | 環境名の直前に使用されるシンボルです。 |
+| `style` | `'bold green'` | モジュールのスタイルです。 |
+| `format` | `'via [$symbol$environment]($style) '` | module のフォーマットです。 |
| `ignore_base` | `true` | アクティブになった時、環境`base`を無視します。 |
| `disabled` | `false` | `conda`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| ----------- | ------------ | ---------------------- |
-| environment | `astronauts` | 現在の conda 環境 |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| ----------- | ------------ | ----------------------- |
+| environment | `astronauts` | 現在の conda 環境 |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -796,7 +853,7 @@ Note: これはconda自身の プロンプト修飾子 を抑制しません。`
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## コンテナ
@@ -807,18 +864,18 @@ format = "[$symbol$environment](dimmed green) "
| オプション | デフォルト | 説明 |
| ---------- | ---------------------------------- | ------------------------- |
-| `symbol` | `"⬢"` | コンテナ内にいる場合、このシンボルが表示されます。 |
-| `style` | `"bold red dimmed"` | モジュールのスタイルです。 |
+| `symbol` | `'⬢'` | コンテナ内にいる場合、このシンボルが表示されます。 |
+| `style` | `'bold red dimmed'` | モジュールのスタイルです。 |
| `format` | `'[$symbol \[$name\]]($style) '` | module のフォーマットです。 |
| `disabled` | `false` | `container`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | ------------------- | ---------------------- |
-| name | `fedora-toolbox:35` | コンテナ名 |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | ------------------- | ----------------------- |
+| name | `fedora-toolbox:35` | コンテナ名 |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -842,22 +899,22 @@ format = '[$symbol \[$name\]]($style) '
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
-| `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 |
-| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `style` | `"bold red"` | モジュールのスタイルです。 |
-| `detect_extensions` | `["cr"]` | どの拡張子がこのモジュールをアクティブにするか |
-| `detect_files` | `["shard.yml"]` | どのファイル名がこのモジュールをアクティブにするか |
+| `symbol` | `'🔮 '` | Crystalのバージョンを表示する前に使用される記号です。 |
+| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `style` | `'bold red'` | モジュールのスタイルです。 |
+| `detect_extensions` | `['cr']` | どの拡張子がこのモジュールをアクティブにするか |
+| `detect_files` | `['shard.yml']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | `crystal`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | --------- | ---------------------- |
-| version | `v0.32.1` | `crystal` のバージョン |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | --------- | ----------------------- |
+| version | `v0.32.1` | `crystal` のバージョン |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -867,7 +924,7 @@ format = '[$symbol \[$name\]]($style) '
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -880,22 +937,22 @@ format = "via [✨ $version](bold blue) "
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `symbol` | `"Λ "` | Damlの記号を表すフォーマット文字列です。 |
-| `style` | `"bold cyan"` | モジュールのスタイルです。 |
+| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `symbol` | `'Λ '` | Damlの記号を表すフォーマット文字列です。 |
+| `style` | `'bold cyan'` | モジュールのスタイルです。 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
-| `detect_files` | `["daml.yaml"]` | どのファイル名がこのモジュールをアクティブにするか |
+| `detect_files` | `['daml.yaml']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | `daml`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | -------- | ---------------------- |
-| version | `v2.2.0` | `daml`のバージョン |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | -------- | ----------------------- |
+| version | `v2.2.0` | `daml`のバージョン |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -905,7 +962,7 @@ format = "via [✨ $version](bold blue) "
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -920,22 +977,22 @@ format = "via [D $version](bold bright-green) "
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `symbol` | `"🎯 "` | Dartのシンボルを表すフォーマット文字列 |
-| `detect_extensions` | `["dart"]` | どの拡張子がこのモジュールをアクティブにするか |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | どのファイル名がこのモジュールをアクティブにするか |
-| `detect_folders` | `[".dart_tool"]` | どのフォルダーがこのモジュールをアクティブにするか |
-| `style` | `"bold blue"` | モジュールのスタイルです。 |
+| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `symbol` | `'🎯 '` | Dartのシンボルを表すフォーマット文字列 |
+| `detect_extensions` | `['dart']` | どの拡張子がこのモジュールをアクティブにするか |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | どのファイル名がこのモジュールをアクティブにするか |
+| `detect_folders` | `['.dart_tool']` | どのフォルダーがこのモジュールをアクティブにするか |
+| `style` | `'bold blue'` | モジュールのスタイルです。 |
| `disabled` | `false` | `dart`モジュールを無効にします。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | -------- | ---------------------- |
-| version | `v2.8.4` | `dart` のバージョン |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | -------- | ----------------------- |
+| version | `v2.8.4` | `dart` のバージョン |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -945,7 +1002,7 @@ format = "via [D $version](bold bright-green) "
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -958,22 +1015,22 @@ format = "via [🔰 $version](bold red) "
| オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
-| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
-| `symbol` | `"🦕 "` | Dart のシンボルを表すフォーマット文字列 |
+| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
+| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
+| `symbol` | `'🦕 '` | Dart のシンボルを表すフォーマット文字列 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | どのファイル名がこのモジュールをアクティブにするか |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
-| `style` | `"green bold"` | モジュールのスタイルです。 |
+| `style` | `'green bold'` | モジュールのスタイルです。 |
| `disabled` | `false` | `deno`モジュールを無効化します。 |
### 変数
-| 変数 | 設定例 | 説明 |
-| --------- | -------- | ---------------------- |
-| version | `v1.8.3` | `deno`のバージョン |
-| symbol | | オプション `記号` の値をミラーする |
-| style\* | | オプション `style` の値をミラーする |
+| 変数 | 設定例 | 説明 |
+| --------- | -------- | ----------------------- |
+| version | `v1.8.3` | `deno`のバージョン |
+| symbol | | オプション `symbol` の値をミラーする |
+| style\* | | オプション `style` の値をミラーする |
### 設定例
@@ -981,33 +1038,34 @@ format = "via [🔰 $version](bold red) "
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
-`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。
+`directory` モジュールは現在のディレクトリへのパスを表示します。親フォルダは3つまでに切り捨てられます。 git リポジトリ内にいる場合は、リポジトリのルートで切り捨てられます。
-fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。
+fish スタイルの pwd オプションを使用している場合、切り捨てられたパスを非表示にする代わりに、オプションで有効にした数値に基づいた各ディレクトリの短縮名が表示されます。
-例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます。
+たとえば、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs` がリポジトリルートであり、オプションが `1` に設定されている場合を挙げます。 この場合、`nixpkgs/pkgs` の代わりに、`~/D/N/nixpkgs/pkgs` と表示されます。
### オプション
-| オプション | デフォルト | 説明 |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
-| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 |
-| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | module のフォーマットです。 |
-| `style` | `"bold cyan"` | モジュールのスタイルです。 |
-| `disabled` | `false` | `directory`モジュールを無効にします。 |
-| `read_only` | `"🔒"` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 |
-| `read_only_style` | `"red"` | 読み取り専用シンボルのスタイルです。 |
-| `truncation_symbol` | `""` | 切り捨てられたパスの接頭辞として付けるシンボルです。 例: "…/" |
-| `repo_root_style` | | gitリポジトリのルートのスタイルです。 デフォルトの値は `style` と同じです。 |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | `repo_root_style` が定義されている場合の git リポジトリのフォーマットです。 |
-| `home_symbol` | `"~"` | ホームディレクトリを示すシンボルです。 |
-| `use_os_path_sep` | `true` | `/`を使用する代わりに、OS固有のパスの区切り文字を使用します。(例: Windowsの場合`\`) |
+| オプション | デフォルト | 説明 |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 |
+| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | module のフォーマットです。 |
+| `style` | `'bold cyan'` | モジュールのスタイルです。 |
+| `disabled` | `false` | `directory`モジュールを無効にします。 |
+| `read_only` | `'🔒'` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 |
+| `read_only_style` | `'red'` | 読み取り専用シンボルのスタイルです。 |
+| `truncation_symbol` | `''` | 切り捨てられたパスの接頭辞として付けるシンボルです。 eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. デフォルトの値は `style` と同じです。 |
+| `repo_root_style` | | gitリポジトリのルートのスタイルです。 デフォルトの値は `style` と同じです。 |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | ホームディレクトリを示すシンボルです。 |
+| `use_os_path_sep` | `true` | `/`を使用する代わりに、OS固有のパスの区切り文字を使用します。(例: Windowsの場合`\`) |
このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。
@@ -1022,8 +1080,8 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1034,8 +1092,8 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
| 変数 | 設定例 | 説明 |
| --------- | --------------------- | ---------------------- |
-| path | `"D:/Projects"` | カレントディレクトリのパス |
-| style\* | `"black bold dimmed"` | オプション `style` の値をミラーする |
+| path | `'D:/Projects'` | カレントディレクトリのパス |
+| style\* | `'black bold dimmed'` | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
@@ -1046,11 +1104,11 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
| 変数 | 設定例 | 説明 |
| ------------------ | --------------------- | ---------------------- |
-| before_root_path | `"/path/to/home/"` | gitルートディレクトリパスの前のパス |
-| repo_root | `"git_repo"` | gitルートディレクトリの名前 |
-| path | `"/src/lib"` | 残りのパス |
-| style | `"black bold dimmed"` | オプション `style` の値をミラーする |
-| repo_root_style | `"underline white"` | gitルートディレクトリの名前のスタイル |
+| before_root_path | `'/path/to/home/'` | gitルートディレクトリパスの前のパス |
+| repo_root | `'git_repo'` | gitルートディレクトリの名前 |
+| path | `'/src/lib'` | 残りのパス |
+| style | `'black bold dimmed'` | オプション `style` の値をミラーする |
+| repo_root_style | `'underline white'` | gitルートディレクトリの名前のスタイル |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Starshipのさらなるカスタマイズを目指すなら以下を参考にし
- **[reujab/silver](https://github.com/reujab/silver)** – アイコンと cross-shell 対応のカスタマイズ可能な powerline ライクなプロンプト。
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md
index 5448391bf..766033740 100644
--- a/docs/ja-JP/presets/README.md
+++ b/docs/ja-JP/presets/README.md
@@ -10,6 +10,14 @@
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
このプリセットは付属のモジュール全てのフォーマットを変更し、デフォルトのStarshipの表示("via", "on", etc.)から、それぞれの情報を括弧で区分けするように変更します。
@@ -28,6 +36,12 @@
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
このプリセットは、[Pure](https://github.com/sindresorhus/pure)の外観と振る舞いをエミュレートします。
@@ -39,3 +53,9 @@
このプリセットは[M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json)にインスパイアされています。 また、starshipでパス置換がどのように機能するかを示しています。
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/ja-JP/presets/no-empty-icons.md b/docs/ja-JP/presets/no-empty-icons.md
new file mode 100644
index 000000000..dc0e27cff
--- /dev/null
+++ b/docs/ja-JP/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[プリセット一覧に戻る](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### 設定
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[クリックしてTOMLをダウンロード](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/ja-JP/presets/no-nerd-font.md b/docs/ja-JP/presets/no-nerd-font.md
new file mode 100644
index 000000000..05886afca
--- /dev/null
+++ b/docs/ja-JP/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[プリセット一覧に戻る](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### 設定
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[クリックしてTOMLをダウンロード](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/ja-JP/presets/tokyo-night.md b/docs/ja-JP/presets/tokyo-night.md
new file mode 100644
index 000000000..60153e2ea
--- /dev/null
+++ b/docs/ja-JP/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[プリセット一覧に戻る](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### 必要なもの
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
+
+### 設定
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[クリックしてTOMLをダウンロード](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/ko-KR/advanced-config/README.md b/docs/ko-KR/advanced-config/README.md
index cacaad68e..cb717320c 100644
--- a/docs/ko-KR/advanced-config/README.md
+++ b/docs/ko-KR/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ If multiple colors are specified for foreground/background, the last one in the
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md
index e9f968901..63a5e67b7 100644
--- a/docs/ko-KR/config/README.md
+++ b/docs/ko-KR/config/README.md
@@ -15,15 +15,17 @@ All configuration for starship is done in this [TOML](https://github.com/toml-la
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+For example:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
@@ -80,9 +138,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
For example:
-- `$version` is a format string with a variable named `version`.
-- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
-- `$git_branch $git_commit` has the two variables separated with a space.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Text Group
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
For example:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
For example:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ This is the list of prompt-wide configuration options.
| Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Example
@@ -178,10 +213,10 @@ This is the list of prompt-wide configuration options.
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Example
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
-| `full_symbol` | `" "` | The symbol shown when the battery is full. |
-| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
-| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
-| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | The symbol shown when the battery is full. |
+| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
+| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -423,9 +478,9 @@ The `battery` module shows how charged the device's battery is and its current c
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery Display
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The `display` option is an array of the following table.
| Option | Default | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `style` | `"red bold"` | The style used if the display option is in use. |
+| `style` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Example
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `'bold red'` | The style for the module. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | The style for the module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | The style for the module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | The style for the module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
-| `symbol` | `"🅒 "` | The symbol used before the environment name. |
-| `style` | `"bold green"` | The style for the module. |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | The symbol used before the environment name. |
+| `style` | `'bold green'` | The style for the module. |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | The style for the module. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | The style for the module. |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | The style for the module. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `style` | `"bold cyan"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | The style for the module. |
+| `style` | `'green bold'` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
-| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `style` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | Default | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
+| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `style` | `'bold cyan'` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Variable | Example | Description |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Variable | Example | Description |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Starship 을 만드는 데에 영감이 되었던 이전 작업들도 살펴보
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/ko-KR/presets/README.md b/docs/ko-KR/presets/README.md
index 26c2314bf..cb3dcf1bc 100644
--- a/docs/ko-KR/presets/README.md
+++ b/docs/ko-KR/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/ko-KR/presets/no-empty-icons.md b/docs/ko-KR/presets/no-empty-icons.md
new file mode 100644
index 000000000..7be6867d1
--- /dev/null
+++ b/docs/ko-KR/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuration
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/ko-KR/presets/no-nerd-font.md b/docs/ko-KR/presets/no-nerd-font.md
new file mode 100644
index 000000000..b154a6c00
--- /dev/null
+++ b/docs/ko-KR/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuration
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/ko-KR/presets/tokyo-night.md b/docs/ko-KR/presets/tokyo-night.md
new file mode 100644
index 000000000..9d7694637
--- /dev/null
+++ b/docs/ko-KR/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### 준비 사항
+
+- 터미널에 [Nerd Font](https://www.nerdfonts.com/)가 설치되어 있고 사용 가능해야 합니다
+
+### Configuration
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/nl-NL/advanced-config/README.md b/docs/nl-NL/advanced-config/README.md
index 3e45a8876..9a8b0fffa 100644
--- a/docs/nl-NL/advanced-config/README.md
+++ b/docs/nl-NL/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ If multiple colors are specified for foreground/background, the last one in the
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md
index e9f968901..63a5e67b7 100644
--- a/docs/nl-NL/config/README.md
+++ b/docs/nl-NL/config/README.md
@@ -15,15 +15,17 @@ All configuration for starship is done in this [TOML](https://github.com/toml-la
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+For example:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
@@ -80,9 +138,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
For example:
-- `$version` is a format string with a variable named `version`.
-- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
-- `$git_branch $git_commit` has the two variables separated with a space.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Text Group
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
For example:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
For example:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ This is the list of prompt-wide configuration options.
| Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Example
@@ -178,10 +213,10 @@ This is the list of prompt-wide configuration options.
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Example
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
-| `full_symbol` | `" "` | The symbol shown when the battery is full. |
-| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
-| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
-| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | The symbol shown when the battery is full. |
+| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
+| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -423,9 +478,9 @@ The `battery` module shows how charged the device's battery is and its current c
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery Display
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The `display` option is an array of the following table.
| Option | Default | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `style` | `"red bold"` | The style used if the display option is in use. |
+| `style` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Example
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `'bold red'` | The style for the module. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | The style for the module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | The style for the module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | The style for the module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
-| `symbol` | `"🅒 "` | The symbol used before the environment name. |
-| `style` | `"bold green"` | The style for the module. |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | The symbol used before the environment name. |
+| `style` | `'bold green'` | The style for the module. |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | The style for the module. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | The style for the module. |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | The style for the module. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `style` | `"bold cyan"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | The style for the module. |
+| `style` | `'green bold'` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
-| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `style` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | Default | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
+| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `style` | `'bold cyan'` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Variable | Example | Description |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Variable | Example | Description |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -415,6 +414,14 @@ Please check out these previous works that helped inspire the creation of starsh
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/nl-NL/presets/README.md b/docs/nl-NL/presets/README.md
index 26c2314bf..cb3dcf1bc 100644
--- a/docs/nl-NL/presets/README.md
+++ b/docs/nl-NL/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/nl-NL/presets/no-empty-icons.md b/docs/nl-NL/presets/no-empty-icons.md
new file mode 100644
index 000000000..7be6867d1
--- /dev/null
+++ b/docs/nl-NL/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuration
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/nl-NL/presets/no-nerd-font.md b/docs/nl-NL/presets/no-nerd-font.md
new file mode 100644
index 000000000..b154a6c00
--- /dev/null
+++ b/docs/nl-NL/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuration
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/nl-NL/presets/tokyo-night.md b/docs/nl-NL/presets/tokyo-night.md
new file mode 100644
index 000000000..8b4afa44b
--- /dev/null
+++ b/docs/nl-NL/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Benodigdheden
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
+
+### Configuration
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/pl-PL/advanced-config/README.md b/docs/pl-PL/advanced-config/README.md
index 89bd62636..f64ab621a 100644
--- a/docs/pl-PL/advanced-config/README.md
+++ b/docs/pl-PL/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ If multiple colors are specified for foreground/background, the last one in the
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md
index 1a480cab4..ad5c92f2d 100644
--- a/docs/pl-PL/config/README.md
+++ b/docs/pl-PL/config/README.md
@@ -15,15 +15,17 @@ Cała konfiguracja starship jest wykonywana w tym pliku [TOML](https://github.co
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
Możesz zmienić domyślną lokalizację pliku konfiguracyjnego za pomocą zmiennej środowiskowej `STARSHIP_CONFIG`:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
W ramach konwencji większość modułów posiada przedrostek w domyślnym kolorze terminala (n.p. `via` w "nodejs") oraz pojedynczy odstęp za treścią modułu.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+Na przykład:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Formatowanie
Moduły wypisują swoje zmienne przy użyciu ciągów formatujących. Większość modułów posiada wpis o nazwie `format`, który konfiguruje format wyświetlania modułu. W ciągach formatujących można używać tekstu, zmiennych oraz grup tekstowych.
@@ -80,9 +138,9 @@ Zmienna zawiera symbol `$`, po którym następuje nazwa zmiennej. The name of a
Na przykład:
-- `$version` to ciąg formatujący ze zmienną o nazwie `version`.
-- `$git_branch$git_commit` zawiera dwie zmienne: `git_branch` i `git_commit`.
-- `$git_branch $git_commit` zawiera te dwie zmienne rozdzielone spacją.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Grupy tekstowe
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
Na przykład:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
Na przykład:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ This is the list of prompt-wide configuration options.
| Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Example
@@ -178,10 +213,10 @@ This is the list of prompt-wide configuration options.
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| Zmienne | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Example
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
-| `full_symbol` | `" "` | The symbol shown when the battery is full. |
-| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
-| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
-| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | The symbol shown when the battery is full. |
+| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
+| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -423,9 +478,9 @@ The `battery` module shows how charged the device's battery is and its current c
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery Display
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The `display` option is an array of the following table.
| Option | Default | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `style` | `"red bold"` | The style used if the display option is in use. |
+| `style` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Example
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `'bold red'` | The style for the module. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | The style for the module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | The style for the module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | The style for the module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
-| `symbol` | `"🅒 "` | The symbol used before the environment name. |
-| `style` | `"bold green"` | The style for the module. |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | The symbol used before the environment name. |
+| `style` | `'bold green'` | The style for the module. |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | The style for the module. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | The style for the module. |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | The style for the module. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `style` | `"bold cyan"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | The style for the module. |
+| `style` | `'green bold'` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
-| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `style` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | Default | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
+| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `style` | `'bold cyan'` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Zmienne | Example | Description |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Zmienne | Example | Description |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Zapoznaj się z wcześniejszymi projektami które zainspirowały nas do stworzen
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/pl-PL/presets/README.md b/docs/pl-PL/presets/README.md
index c601524bb..660dbff3c 100644
--- a/docs/pl-PL/presets/README.md
+++ b/docs/pl-PL/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Moduły w nawiasach kwadratowych](./bracketed-segments.md)
Ta konfiguracja zmienia format wyświetlania wbudowanych modułów - zamiast domyślnych wyrazów ("via", "on", itp.) są wypisywane w nawiasach kwadratowych.
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/pl-PL/presets/no-empty-icons.md b/docs/pl-PL/presets/no-empty-icons.md
new file mode 100644
index 000000000..edd626103
--- /dev/null
+++ b/docs/pl-PL/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Konfiguracja
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/pl-PL/presets/no-nerd-font.md b/docs/pl-PL/presets/no-nerd-font.md
new file mode 100644
index 000000000..74f77c45a
--- /dev/null
+++ b/docs/pl-PL/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Konfiguracja
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/pl-PL/presets/tokyo-night.md b/docs/pl-PL/presets/tokyo-night.md
new file mode 100644
index 000000000..2246f1278
--- /dev/null
+++ b/docs/pl-PL/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Wymagania wstępne
+
+- Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i włączona w twoim terminalu
+
+### Konfiguracja
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md
index ac838e54e..dbcf79bf4 100644
--- a/docs/pt-BR/README.md
+++ b/docs/pt-BR/README.md
@@ -55,7 +55,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
```sh
brew install starship
```
- With [Winget](https://github.com/microsoft/winget-cli):
+ Com o [Winget](https://github.com/microsoft/winget-cli):
```powershell
winget install starship
@@ -121,7 +121,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
::: atenção
- Only elvish v0.18 or higher is supported.
+ Apenas elvish v0.18 ou superior é suportado.
:::
@@ -149,11 +149,11 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
::: atenção
- This will change in the future. Somente Nushell v0.61+ é suportado.
+ Isto irá mudar no futuro. Somente Nushell v0.61+ é suportado.
:::
- Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
+ Adicione o seguinte ao final do seu arquivo env do Nushell (encontre-o executando `$nu.env-path` no Nushell):
```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
diff --git a/docs/pt-BR/advanced-config/README.md b/docs/pt-BR/advanced-config/README.md
index fb891a6fb..f6f3437ee 100644
--- a/docs/pt-BR/advanced-config/README.md
+++ b/docs/pt-BR/advanced-config/README.md
@@ -8,7 +8,7 @@ As configurações nesta seção estão sujeitas a alterações em futuras vers
:::
-## TransientPrompt in PowerShell
+## TransientPrompt no PowerShell
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put this statement in your `$PROFILE`. Transience can be disabled on-the-fly with `Disable-TransientPrompt`.
@@ -205,7 +205,9 @@ Alguns shells suportam um prompt direito que é renderizado na mesma linha que a
Nota: O prompt direito é uma única linha após o local de entrada. Para alinhar módulos à direita acima da linha de entrada em um prompt de várias linhas, consulte o [módulo `fill`](/config/#fill).
-`right_format` é atualmente compatível com os seguintes shells: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ Se várias cores forem especificadas para primeiro plano/plano de fundo, a últi
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md
index b8af885fc..7792fa5b9 100644
--- a/docs/pt-BR/config/README.md
+++ b/docs/pt-BR/config/README.md
@@ -9,21 +9,23 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml):
```toml
-# Obtém os preenchimentos automáticos do editor com base em um esquema de configuração
+# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'
-# Insere uma quebra de linha entre os prompts do shell
+# Inserts a blank line between shell prompts
add_newline = true
-# Substitui o símbolo "❯" no prompt por "➜"
-[character] # O nome do módulo que estamos configurando é "character"
-success_symbol = "[➜](bold green)" # O segmento "success_symbol" está sendo definido como "➜" com a cor verde em negrito
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
-# Desativa o módulo do pacote, ocultando-o completamente do prompt
+# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
Você pode alterar o caminho padrão do arquivo de configuração com a variável de ambiente `STARSHIP_CONFIG`:
```sh
@@ -70,106 +72,139 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Por convenção, a maioria dos módulos tem um prefixo de cor (e.x. `via` no "nodejs") e um espaço vazio para sufixo.
-### Formatação de Strings
+### Strings
-Formatar uma string é a forma de como o módulo ira imprimir suas variáveis. A maioria dos módulos tem uma entrada chamada `format` que configura o formato que o módulo é exibido. Você pode usar textos, variáveis e grupo de textos em uma formatação de string.
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
-#### Variável
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
-Uma variável contem um simbolo `$` seguido pelo nome da variável. O nome de uma variável pode apenas conter letras, números e `_`.
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
Por exemplo:
-- `$version` é uma formatação de string com uma variável chamada `version`.
-- `$git_branch$git_commit` é uma formatação de string com duas variáveis chamadas `git_branch` e `git_commit`.
-- `$git_branch $git_commit` Tem as duas variáveis separadas por espaço.
-
-#### Grupo de Texto
-
-Um grupo de texto é composto por duas partes diferentes.
-
-A primeira parte, é contida em um `[]`, é uma [formatação de string](#format-strings). Você pode adicionar textos, variáveis ou até mesmos grupo de textos aninhados.
-
-Na segunda parte, é composta por um `()`, é uma [estilização de string](#style-strings). Isto pode ser usado para estilizar a primeira parte.
-
-Por exemplo:
-
-- `[on](red bold)` vai imprimir uma string `on` com texto em negrito e com a cor vermelha.
-- `[⌘ $version](bold green)` vai imprimir o simbolo `⌘` seguido pela variável `version`, com o texto em negrito e na cor verde.
-- `[a [b](red) c](green)` vai imprimir `a b c` com `b` vermelho, e `a` e `c` verde.
-
-#### Estilo dos textos
-
-A maioria dos módulos do starship permite que você configure o estilo de exibição dos textos. Isso é feito através de um parâmetro (geralmente chamado `style`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo e o que elas fazem. Para detalhes sobre a sintaxe completa, consulte o [guia de configurações avançadas](/advanced-config/).
-
-- `"fg:green bg:blue"` deixa o texto verde com o fundo azul
-- `"bg:blue fg:bright-green"` deixa o texto verde brilhante com o fundo azul
-- `"bold fg:27"` deixa o texto em negrito com a cor 27 [da tabela ANSI](https://i.stack.imgur.com/KTSQa.png)
-- `"underline bg:#bf5700"` deixa o texto sublinhado com o fundo laranja escuro
-- `"bold italic fg:purple"` deixa o texto em negrito e itálico com a cor roxa
-- `""` desabilita explicitamente todos os estilos
-
-Note que a aparência do estilo será controlado pelo seu terminal. Por exemplo, alguns terminais deixarão as cores mais brilhantes ao invés de deixar o texto em negrito, ou alguns temas podem usar as mesmas cores para cores brilhantes e normais. Além disso, para textos em itálico, o terminal precisa ter suporte.
-
-#### Formatação de String Condicional
-
-Uma formatação condicional de string é envolto por `(` e `)` não vai ser exibido caso a variável dentro esteja vazia.
-
-Por exemplo:
-
-- `(@$region)` não vai exibir nada caso a variável `region` seja `None` ou vazia, caso contrario vai exibir `@` seguido pelo valor da variável region.
-- `(texto qualquer)` não vai exibir nada sempre, pois não existe variável entre os parenteses.
-- Quando usar `$all` é um atalho para `\[$a$b\]`, `($all)` vai exibir nada somente quando `$a` e `$b` são `None`. Isto funciona da mesma forma que `(\[$a$b\] )`.
-
-#### Caracteres Especiais
-
-O símbolos a seguir tem um uso na formatação de string e deve ser escapados `$ \ [ ] ( )`.
-
-Note que TOML tem [string básicas e strings literais](https://toml.io/en/v1.0.0#string). É recomendado usar um string literal(cercado por aspas simples) em seu config. Se você quiser usar uma string básica(cercado por aspas duplas), você precisa adicionar o backslash (ex: use `\\`).
-
-Por exemplo, quando você quer imprimir um simbolo `$` em uma nova linha, as configurações de `format` a seguir são equivalentes:
-
```toml
-# com string básica
-format = "\n\\$"
+# literal string
+format = '☺\☻ '
-# com múltiplas linhas de string básica
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
format = """
\\$"""
-# com string literal
-format = '''
-
-\$'''
+# with basic string
+format = "\n\\$"
```
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
+### Formatação de Strings
+
+As strings de formato são o formato com o qual um módulo imprime todas as suas variáveis. A maioria dos módulos tem uma entrada chamada `format` que configura o formato de exibição do módulo. Você pode usar textos, variáveis e grupos de texto em uma string de formato.
+
+#### Variável
+
+Uma variável contém um símbolo `$` seguido pelo nome da variável. O nome de uma variável pode conter apenas letras, números e `_`.
+
+Por exemplo:
+
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
+
+#### Grupo de Texto
+
+Um grupo de texto é composto de duas partes diferentes.
+
+A primeira parte, que está entre um `[]`, é uma [string de formato](#format-strings). Você pode adicionar textos, variáveis ou até mesmo grupos de texto aninhados nele.
+
+Na segunda parte, que está dentro de um `()`, está uma [string de estilo](#style-strings). Isso pode ser usado para estilizar a primeira parte.
+
+Por exemplo:
+
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
+
+#### Estilo dos textos
+
+A maioria dos módulos no starship permite que você configure seus estilos de exibição. Isso é feito com uma entrada (normalmente chamada de `estilo`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo junto com o que elas fazem. Para obter detalhes sobre a sintaxe completa, consulte o [guia de configuração avançada](/advanced-config/).
+
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
+
+Observe que a aparência do estilo será controlada pelo emulador de terminal. Por exemplo, alguns emuladores de terminal irão clarear as cores em vez de colocar o texto em negrito, e alguns temas de cores usam os mesmos valores para as cores normais e brilhantes. Além disso, para obter texto em itálico, seu terminal deve suportar itálico.
+
+#### Formatação de String Condicional
+
+Uma string de formato condicional envolta de `(` e `)` não será renderizada se todas as variáveis internas estiverem vazias.
+
+Por exemplo:
+
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
+
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt de Comando
-Está é a lista de opções de configuração de prompt.
+Esta é a lista de opções de configuração em todo o prompt.
### Opções
| Opções | Padrão | Descrição |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configura o formato do prompt. |
-| `right_format` | `""` | Veja [Ativa o prompt direito](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | Veja [Ativa o prompt direito](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Tempo limite para escanear arquivos (em milissegundos). |
| `command_timeout` | `500` | Tempo limite de execução de comandos pelo starship (em milissegundos). |
| `add_newline` | `true` | Insere linha vazia entre os prompts do shell. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Exemplo
@@ -177,35 +212,35 @@ Está é a lista de opções de configuração de prompt.
```toml
# ~/.config/starship.toml
-# Usa um format customizado
-format = """
+# Use custom format
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
-#Espera 10 milissegundos para que o starship check os arquivos do diretório atual.
+# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Format de Prompt Padrão
-O `formato` padrão é usado para definir o formato do prompt, se um valor vazio ou não `formatado` for informado. Os valores padrão são os seguintes:
+O padrão `format` é usado para definir o formato do prompt, se estiver vazio ou nenhum `format` for fornecido. O padrão é como mostrado:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,16 +319,17 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
```
-Se você quer estender o formato padrão, você pode usar `$all`; Os módulos adicionado explicitamente não serão duplicados. Ex.
+Se você quiser apenas estender o formato padrão, você pode usar `$all`; os módulos que você adicionar explicitamente ao formato não serão duplicados. Ex.
```toml
-# Move o diretório para a segunda linha
-format = "$all$directory$character"
+# Move the directory to the second line
+format = '$all$directory$character'
```
## AWS
@@ -299,21 +338,23 @@ The `aws` module shows the current AWS region and profile and an expiration time
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
-Quando usar [aws-vault](https://github.com/99designs/aws-vault) o perfil é lido da variável `AWS_VAULT` e o tempo de expiração de credenciais é lida da variável de env `AWS_SESSION_EXPIRATION`.
+Quando usar [aws-vault](https://github.com/99designs/aws-vault), o perfil é lido da variável de ambiente `AWS_VAULT` e o tempo de expiração de credenciais é lido da variável de ambiente `AWS_SESSION_EXPIRATION`.
Quando usar [awsu](https://github.com/kreuzwerker/awsu) o perfil é lido da varável de env `AWSU_PROFILE`.
Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROFILE` e o tempo de expiração de credenciais é lida da variável de env `AWSUME_EXPIRATION`.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Opções
| Opções | Padrão | Descrição |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | O formato do módulo. |
-| `symbol` | `"☁️ "` | O símbolo usado antes de exibir o perfil atual da AWS. |
-| `region_aliases` | | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. |
-| `profile_aliases` | | Tabela de apelidos de perfil a serem exibidos além do nome da AWS. |
-| `style` | `"bold yellow"` | O estilo do módulo. |
+| `symbol` | `'☁️ '` | O símbolo usado antes de exibir o perfil atual da AWS. |
+| `region_aliases` | `{}` | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. |
+| `profile_aliases` | `{}` | Tabela de apelidos de perfil a serem exibidos além do nome da AWS. |
+| `style` | `'bold yellow'` | O estilo do módulo. |
| `expiration_symbol` | `X` | O simbolo exibido quando as credenciais temporárias estão expiradas. |
| `disabled` | `false` | Desabilita o módulo `AWS`. |
| `force_display` | `false` | Se `true` exibe as informações mesmo que `credentials`, `credential_process` ou `sso_start_url` não tenham sido configurados. |
@@ -339,13 +380,13 @@ Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROF
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
-ChamadaDeAcessoDoGrupoDaEmpresaFrobozz = 'Frobozz'
+CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
#### Exibir região
@@ -354,12 +395,12 @@ ChamadaDeAcessoDoGrupoDaEmpresaFrobozz = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Exibir perfil
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
-Esquema_De_Nomenclatura_Empresarial-voidstars = 'void**'
+Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-O módulo `azure` exibe a assinatura Azure atual. Isto é baseado na exibição do nome da assinatura padrão, como definido no arquivo em `~/.azure/azureProfile.json`.
+O módulo `azure` exibe a assinatura Azure atual. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Opções
| Variável | Padrão | Descrição |
| ---------- | ---------------------------------------- | ---------------------------------------------- |
-| `format` | `"on [$symbol($subscription)]($style) "` | O formato que o módulo Azure será renderizado. |
-| `symbol` | `"ﴃ "` | O símbolo usado no formato. |
-| `style` | `"blue bold"` | O estilo usado no formato. |
+| `format` | `'on [$symbol($subscription)]($style) '` | O formato que o módulo Azure será renderizado. |
+| `symbol` | `'ﴃ '` | O símbolo usado no formato. |
+| `style` | `'blue bold'` | O estilo usado no formato. |
| `disabled` | `true` | Desabilita o módulo `azure`. |
-### Exemplo
+### Exemplos
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "em [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ O módulo `battery` exibe o quanto a bateria do dispositivo está carregada e o
| Opções | Padrão | Descrição |
| -------------------- | --------------------------------- | ------------------------------------------------------------ |
-| `full_symbol` | `" "` | O simbolo exibido quando a bateria estiver cheia. |
-| `charging_symbol` | `" "` | O simbolo exibido quando a bateria está carregando. |
-| `discharging_symbol` | `" "` | O simbolo exibido quando a bateria está descarregando. |
-| `unknown_symbol` | `" "` | O simbolo exibido quando o estado da bateria é desconhecido. |
-| `empty_symbol` | `" "` | O simbolo exibido quando o estado da bateria é vazio. |
-| `format` | `"[$symbol$percentage]($style) "` | O formato do módulo. |
+| `full_symbol` | `' '` | O simbolo exibido quando a bateria estiver cheia. |
+| `charging_symbol` | `' '` | O simbolo exibido quando a bateria está carregando. |
+| `discharging_symbol` | `' '` | O simbolo exibido quando a bateria está descarregando. |
+| `unknown_symbol` | `' '` | O simbolo exibido quando o estado da bateria é desconhecido. |
+| `empty_symbol` | `' '` | O simbolo exibido quando o estado da bateria é vazio. |
+| `format` | `'[$symbol$percentage]($style) '` | O formato do módulo. |
| `display` | [link](#battery-display) | Limite de exibição e estilo para o módulo. |
| `disabled` | `false` | Desabilita o módulo `battery`. |
@@ -423,19 +478,19 @@ O módulo `battery` exibe o quanto a bateria do dispositivo está carregada e o
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Indicador de bateria
-A configuração `display` é usada para definir quando o indicador de bateria deve ser exibido (threshold), qual deve ser o simbolo(symbol) e como você gostaria de exibir (style). Se nenhum `display` for fornecido. Os valores padrão são os seguintes:
+A configuração `display` é usada para definir quando o indicador de bateria deve ser exibido (threshold), qual deve ser o simbolo(symbol) e como você gostaria de exibir (style). Se nenhum `display` for fornecido. O padrão é como mostrado:
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
O valor padrão das opções `charging_symbol` e `discharging_symbol`é respectivamente o valor das opções `battery`'s `charging_symbol` e `discharging_symbol`.
@@ -447,23 +502,23 @@ A opção `display` é um array da seguinte tabela.
| Opções | Padrão | Descrição |
| -------------------- | ------------ | -------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | O limite superior para exibição. |
-| `style` | `"red bold"` | O estilo usado para exibir quando estiver em uso. |
+| `style` | `'red bold'` | O estilo usado para exibir quando estiver em uso. |
| `charging_symbol` | | Simbolo opcional, mostrado quando a opção estiver em uso, o simbolo padrão é `charging_symbol`. |
| `discharging_symbol` | | Simbolo opcional, mostrado quando a opção estiver em uso, o simbolo padrão é `discharging_symbol`. |
#### Exemplo
```toml
-[[battery.display]] # estilo negrito com vermelho e discharging_symbol quando a capacidade está entre 0% e 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # estilo negrito com amarelo e símbolo 💦 quando a capacidade está entre 10% e 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
-# quando a capacidade for superior a 30%, o indicador da bateria não será exibido
+# when capacity is over 30%, the battery indicator will not be displayed
```
## Buf
@@ -477,13 +532,13 @@ O módulo `buf` mostra a versão instalada do [Buf](https://buf.build). Por padr
| Opções | Padrão | Descrição |
| ------------------- | ----------------------------------------------- | ------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | O formato do módulo `buf`. |
-| `version_format` | `"v${raw}"` | O formato da versão. |
-| `symbol` | `"🦬 "` | O símbolo usado antes de exibir a versão do Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | O formato do módulo `buf`. |
+| `version_format` | `'v${raw}'` | A versão formatada. |
+| `symbol` | `'🦬 '` | O símbolo usado antes de exibir a versão do Buf. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
-| `style` | `"bold blue"` | O estilo do módulo. |
+| `style` | `'bold blue'` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `elixir`. |
### Variáveis
@@ -502,7 +557,7 @@ O módulo `buf` mostra a versão instalada do [Buf](https://buf.build). Por padr
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -514,16 +569,16 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🍞 "` | Uma string que representa o simbolo do Node.js. |
-| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Quais nomes de arquivos devem ativar este módulo. |
-| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
-| `style` | `"bold red"` | O estilo do módulo. |
-| `disabled` | `false` | Disables the `bun` module. |
+| Opções | Padrão | Descrição |
+| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
+| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
+| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
+| `style` | `'bold red'` | O estilo do módulo. |
+| `disabled` | `false` | Disables the `bun` module. |
### Variáveis
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -550,17 +605,17 @@ O módulo `c` mostra algumas informações sobre o seu compilador de C. Por padr
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | A string de formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | O símbolo utilizado antes de exibir os detalhes do compilador |
-| `detect_extensions` | `["c", "h"]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
-| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | Como detectar qual é o compilador |
-| `style` | `"bold 149"` | O estilo do módulo. |
-| `disabled` | `false` | Desabilita o módulo `c`. |
+| Opções | Padrão | Descrição |
+| ------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | A string de formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | O símbolo utilizado antes de exibir os detalhes do compilador |
+| `detect_extensions` | `['c', 'h']` | Quais extensões devem ativar este módulo. |
+| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | Como detectar qual é o compilador |
+| `style` | `'bold 149'` | O estilo do módulo. |
+| `disabled` | `false` | Desabilita o módulo `c`. |
### Variáveis
@@ -577,7 +632,7 @@ Note que `version` não está no formato padrão.
A opção `commands` aceita uma lista de comandos para determinar a versão e o nome do compilador.
-Cada comando é representado como uma lista do nome do executável, seguido de seus argumentos, geralmente algo como `["mycc", "--version"]`. Starship tentará executar cada comando até que obtenha um resultado no STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship tentará executar cada comando até que obtenha um resultado no STDOUT.
Se um compilador C não é suportado por este módulo, você pode solicitá-lo [criando uma issue no GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ Se um compilador C não é suportado por este módulo, você pode solicitá-lo [
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Caractere
@@ -611,13 +666,13 @@ Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olh
| Opções | Padrão | Descrição |
| --------------------------- | -------------------- | ------------------------------------------------------------------------------------------- |
-| `format` | `"$symbol"` | O formato da string usado antes da entrada dos textos. |
-| `success_symbol` | `"[❯](bold green)"` | O formato da string usado antes da entrada de texto se o comando anterior for bem-sucedido. |
-| `error_symbol` | `"[❯](bold red)"` | O formato de string usado antes da entrada de texto se o comando anterior tiver falhado. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | O formato da string usado antes da entrada dos textos. |
+| `success_symbol` | `'[❯](bold green)'` | O formato da string usado antes da entrada de texto se o comando anterior for bem-sucedido. |
+| `error_symbol` | `'[❯](bold red)'` | O formato de string usado antes da entrada de texto se o comando anterior tiver falhado. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Desabilita o módulo `character`. |
### Variáveis
@@ -634,8 +689,8 @@ Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olh
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Sem formas customizadas de erro
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### Com formas customizadas no vim
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -666,16 +721,16 @@ O módulo `cmake` exibe a versão instalada do [CMake](https://cmake.org/). Por
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"△ "` | O simbolo usado antes da versão do cmake. |
-| `detect_extensions` | `[]` | Quais extensões devem acionar este módulo |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | [] |
-| `detect_folders` | `[]` | Quais pastas devem ativar este módulo |
-| `style` | `"bold blue"` | O estilo do módulo. |
-| `disabled` | `false` | Desabilita o módulo `cmake`. |
+| Opções | Padrão | Descrição |
+| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------- |
+| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'△ '` | O simbolo usado antes da versão do cmake. |
+| `detect_extensions` | `[]` | Quais extensões devem acionar este módulo |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | [] |
+| `detect_folders` | `[]` | Quais pastas devem ativar este módulo |
+| `style` | `'bold blue'` | O estilo do módulo. |
+| `disabled` | `false` | Desabilita o módulo `cmake`. |
### Variáveis
@@ -696,16 +751,16 @@ O módulo `cobol` exibe a versão instalada atual do COBOL. Por padrão, o módu
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
-| `symbol` | `"⚙️ "` | O simbolo usado antes de exibir a versão do COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | O estilo do módulo. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
-| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
-| `disabled` | `false` | Desabilita o módulo `cobol`. |
+| Opções | Padrão | Descrição |
+| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
+| `symbol` | `'⚙️ '` | O simbolo usado antes de exibir a versão do COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | O estilo do módulo. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Quais extensões devem ativar este módulo. |
+| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
+| `disabled` | `false` | Desabilita o módulo `cobol`. |
### Variáveis
@@ -735,8 +790,8 @@ Usuários do bash que precisam de funções pre-executadas podem usar [rcaloras'
| ---------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Duração mais curta para exibir o tempo (em milissegundos). |
| `show_milliseconds` | `false` | Exibir milissegundos ou invés de segundos para duração. |
-| `format` | `"took [$duration]($style) "` | O formato do módulo. |
-| `style` | `"bold yellow"` | O estilo do módulo. |
+| `format` | `'took [$duration]($style) '` | O formato do módulo. |
+| `style` | `'bold yellow'` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `cmd_duration`. |
| `show_notifications` | `false` | Exibi notificações no desktop quando o comando for concluído. |
| `min_time_to_notify` | `45_000` | Tempo minimo para notificação (em milissegundos). |
@@ -758,7 +813,7 @@ Usuários do bash que precisam de funções pre-executadas podem usar [rcaloras'
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ Isso não suprime o modificador de prompt do conda, você pode executar `conda c
| Opções | Padrão | Descrição |
| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | O número de diretórios do envirionment path deve ser truncado, se o environment foi criado via `conda create -p [path]`. `0` quer dizer sem truncação. Também consulte o módulo [`directory`](#directory). |
-| `symbol` | `"🅒 "` | O simbolo usado antes do nome do environment. |
-| `style` | `"bold green"` | O estilo do módulo. |
-| `format` | `"via [$symbol$environment]($style) "` | O formato do módulo. |
+| `symbol` | `'🅒 '` | O simbolo usado antes do nome do environment. |
+| `style` | `'bold green'` | O estilo do módulo. |
+| `format` | `'via [$symbol$environment]($style) '` | O formato do módulo. |
| `ignore_base` | `true` | Ignora o environment `base` quando ativado. |
| `disabled` | `false` | Desabilita o módulo `conda`. |
@@ -798,7 +853,7 @@ Isso não suprime o modificador de prompt do conda, você pode executar `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ O módulo `container` exibe um símbolo e nome do contêiner, se dentro de um co
| Opções | Padrão | Descrição |
| ---------- | ---------------------------------- | ------------------------------------------------- |
-| `symbol` | `"⬢"` | O símbolo mostrado, quando dentro de um contêiner |
-| `style` | `"bold red dimmed"` | O estilo do módulo. |
+| `symbol` | `'⬢'` | O símbolo mostrado, quando dentro de um contêiner |
+| `style` | `'bold red dimmed'` | O estilo do módulo. |
| `format` | `'[$symbol \[$name\]]($style) '` | O formato do módulo. |
| `disabled` | `false` | Desabilita o módulo `container`. |
@@ -842,16 +897,16 @@ O módulo `crystal` exibe a versão instalada atual do [Crystal](https://crystal
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
-| `symbol` | `"🔮 "` | O simbolo usado antes de exibir a versão do crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | O estilo do módulo. |
-| `detect_extensions` | `["cr"]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `["shard.yml"]` | Quais nomes de arquivos devem ativar este módulo. |
-| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
-| `disabled` | `false` | Desabilita o módulo `crystal`. |
+| Opções | Padrão | Descrição |
+| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
+| `symbol` | `'🔮 '` | O símbolo usado antes de exibir a versão do crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | O estilo do módulo. |
+| `detect_extensions` | `['cr']` | Quais extensões devem ativar este módulo. |
+| `detect_files` | `['shard.yml']` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
+| `disabled` | `false` | Desabilita o módulo `crystal`. |
### Variáveis
@@ -869,7 +924,7 @@ O módulo `crystal` exibe a versão instalada atual do [Crystal](https://crystal
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -880,16 +935,16 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
-| `style` | `"bold cyan"` | O estilo do módulo. |
-| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `["daml.yaml"]` | Quais nomes de arquivos devem ativar este módulo. |
-| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
-| `disabled` | `false` | Disables the `daml` module. |
+| Opções | Padrão | Descrição |
+| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
+| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | O estilo do módulo. |
+| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
+| `detect_files` | `['daml.yaml']` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
+| `disabled` | `false` | Disables the `daml` module. |
### Variáveis
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -920,16 +975,16 @@ O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). P
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🎯 "` | Um formato de string que representa o simbolo do Dart |
-| `detect_extensions` | `["dart"]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Quais nomes de arquivos devem ativar este módulo. |
-| `detect_folders` | `[".dart_tool"]` | Quais pastas devem ativar este módulo. |
-| `style` | `"bold blue"` | O estilo do módulo. |
-| `disabled` | `false` | Desabilita o módulo `dart`. |
+| Opções | Padrão | Descrição |
+| ------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | Um formato de string que representa o simbolo do Dart |
+| `detect_extensions` | `['dart']` | Quais extensões devem ativar este módulo. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_folders` | `['.dart_tool']` | Quais pastas devem ativar este módulo. |
+| `style` | `'bold blue'` | O estilo do módulo. |
+| `disabled` | `false` | Desabilita o módulo `dart`. |
### Variáveis
@@ -947,7 +1002,7 @@ O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). P
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -958,16 +1013,16 @@ O módulo `deno` exibe a versão instalada atual do [Deno](https://deno.land/).
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
-| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🦕 "` | Um formato de string que representa o simbolo do Deno |
-| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Quais nomes de arquivos devem ativar este módulo. |
-| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
-| `style` | `"green bold"` | O estilo do módulo. |
-| `disabled` | `false` | Desabilita o módulo `deno`. |
+| Opções | Padrão | Descrição |
+| ------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. |
+| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🦕 '` | Um formato de string que representa o simbolo do Deno |
+| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Quais nomes de arquivos devem ativar este módulo. |
+| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
+| `style` | `'green bold'` | O estilo do módulo. |
+| `disabled` | `false` | Desabilita o módulo `deno`. |
### Variáveis
@@ -983,7 +1038,7 @@ O módulo `deno` exibe a versão instalada atual do [Deno](https://deno.land/).
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Diretório
@@ -996,20 +1051,21 @@ Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz
### Opções
-| Opções | Padrão | Descrição |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | O número de pastas pais do diretório atual que serão truncadas. |
-| `truncate_to_repo` | `true` | Seu diretório será truncado ou não para a raiz do repositório git atual. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | O formato do módulo. |
-| `style` | `"bold cyan"` | O estilo do módulo. |
-| `disabled` | `false` | Desabilita o módulo `directory`. |
-| `read_only` | `"🔒"` | O simbolo que indica que o diretório atual é somente leitura. |
-| `read_only_style` | `"red"` | O estilo para o simbolo de somente leitura. |
-| `truncation_symbol` | `""` | O simbolo para prefixo de caminhos truncados. ex: "…/" |
-| `repo_root_style` | | O estilo para a raiz do repositório git. O valor padrão é equivalente a `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | O formato de um repositório git quando `repo_root_style` é definido. |
-| `home_symbol` | `"~"` | O simbolo para indicar o diretório home. |
-| `use_os_path_sep` | `true` | Use o separador de caminho específico do sistema opracional em vez de sempre usar `/` (por exemplo, `\` no Windows) |
+| Opções | Padrão | Descrição |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | O número de pastas pais do diretório atual que serão truncadas. |
+| `truncate_to_repo` | `true` | Seu diretório será truncado ou não para a raiz do repositório git atual. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | O formato do módulo. |
+| `style` | `'bold cyan'` | O estilo do módulo. |
+| `disabled` | `false` | Desabilita o módulo `directory`. |
+| `read_only` | `'🔒'` | O simbolo que indica que o diretório atual é somente leitura. |
+| `read_only_style` | `'red'` | O estilo para o simbolo de somente leitura. |
+| `truncation_symbol` | `''` | O simbolo para prefixo de caminhos truncados. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. O valor padrão é equivalente a `style`. |
+| `repo_root_style` | | O estilo para a raiz do repositório git. O valor padrão é equivalente a `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | O simbolo para indicar o diretório home. |
+| `use_os_path_sep` | `true` | Use o separador de caminho específico do sistema opracional em vez de sempre usar `/` (por exemplo, `\` no Windows) |
Este módulo tem algumas configurações avançadas que controlam como o diretório é exibido.
@@ -1024,8 +1080,8 @@ Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interage com as opções de truncação padrão de uma forma que pode suprimir no começo: se não for zero, os componentes do path que normalmente seriam truncados são exibidos com todos caracteres. Por exemplo, o caminho `/built/this/city/on/rock/and/roll`, que normalmente seria exibido como`rock/and/roll`, seria exibido como `/b/t/c/o/rock/and/roll` com`fish_style_pwd_dir_length = 1`--os componentes de path que normalmente seriam removidos são exibidos com um único caractere. Para `fish_style_pwd_dir_length = 2`, seria `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz
| Variável | Exemplo | Descrição |
| --------- | --------------------- | -------------------------------- |
-| path | `"D:/Projects"` | O caminho do diretório atual |
-| style\* | `"black bold dimmed"` | Espelha o valor da opção `style` |
+| path | `'D:/Projetos'` | O caminho do diretório atual |
+| style\* | `'black bold dimmed'` | Espelha o valor da opção `style` |
*: Esta variável só pode ser usada como parte de uma string de estilo
@@ -1048,11 +1104,11 @@ Vamos considerar o caminho `/caminho/para/home/git_repo/src/lib`
| Variável | Exemplo | Descrição |
| ------------------ | ----------------------- | --------------------------------------------------- |
-| before_root_path | `"/caminho/para/home/"` | O caminho antes do caminho do diretório raiz do git |
-| repo_root | `"git_repo"` | O nome do diretório raiz do git |
-| path | `"/src/lib"` | O caminho restante |
-| style | `"black bold dimmed"` | Espelha o valor da opção `style` |
-| repo_root_style | `"underline white"` | Estilo para o nome do diretório raiz do git |
+| before_root_path | `'/caminho/para/home/'` | O caminho antes do caminho do diretório raiz do git |
+| repo_root | `'git_repo'` | O nome do diretório raiz do git |
+| path | `'/src/lib'` | O caminho restante |
+| style | `'black bold dimmed'` | Espelha o valor da opção `style` |
+| repo_root_style | `'underline white'` | Estilo para o nome do diretório raiz do git |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Por favor, confira estes projetos anteriores que ajudaram a inspirar a criação
- **[reujab/silver](https://github.com/reujab/silver)** – Um prompt personalizável com ícones do tipo powerline.
+## ❤️ Patrocinadores
+
+Apoie este projeto [tornando-se um patrocinador](https://github.com/sponsors/starship). O seu nome ou logotipo aparecerá aqui com um link para o seu site.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
@@ -424,4 +431,4 @@ Por favor, confira estes projetos anteriores que ajudaram a inspirar a criação
## 📝 Licença
-Todos os direitos reservados © 2019-Presente, [Contribuidores Starship](https://github.com/starship/starship/graphs/contributors).
Este projeto está licenciado pelo [ISC](https://github.com/starship/starship/blob/master/LICENSE).
+Copyright © 2019-presente, [Colaboradores Starship](https://github.com/starship/starship/graphs/contributors).
Este projeto é licenciado pelo [ISC](https://github.com/starship/starship/blob/master/LICENSE).
diff --git a/docs/pt-BR/presets/README.md b/docs/pt-BR/presets/README.md
index e097f5fc9..297a3e407 100644
--- a/docs/pt-BR/presets/README.md
+++ b/docs/pt-BR/presets/README.md
@@ -10,9 +10,17 @@ Essa personalização altera os símbolos para cada módulo usar Nerd Font.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Seguimentos entre colchetes](./bracketed-segments.md)
-Está personalização altera o formato de todos os módulos integrados para que usem colchetes ao mostrar o seguimento ao invés de usar texto convencional do Starship ("via", "on", etc.).
+Esta configuração altera o formato de todos os módulos internos para mostrar seus respectivos segmentos entre colchetes em vez de usar o texto convencional do Starship ("via", "on", etc.).
[](./bracketed-segments)
@@ -20,22 +28,34 @@ Está personalização altera o formato de todos os módulos integrados para que
Essa personalização converte os símbolos para cada módulo em texto simples. Importante para quando não tiver suporte para caracteres Unicode.
-[](./plain-text)
+[](./plain-text)
## [Runtime Ausente](./no-runtimes.md)
-Está predefinição oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, este é 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ê!
-[](./no-runtimes)
+[](./no-runtimes)
+
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
## [Prompt do Terminal com Pure](./pure-preset.md)
-Essa personalização simula a aparência e o comportamento do [Pure](https://github.com/sindresorhus/pure).
+Essa personalização simula o comportamento e aparência do [Pure](https://github.com/sindresorhus/pure).
-[](./pure-preset)
+[](./pure-preset)
## [Pastel Powerline](./pastel-powerline.md)
Esta personalização é inspirada em [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Mostra também como a substituição de segmentos do caminho completo do diretório funciona no starship.
-[](./pastel-powerline)
+[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/pt-BR/presets/no-empty-icons.md b/docs/pt-BR/presets/no-empty-icons.md
new file mode 100644
index 000000000..5c083f2d4
--- /dev/null
+++ b/docs/pt-BR/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Retornar para Personalizações](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuração
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Clique para baixar o TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/pt-BR/presets/no-nerd-font.md b/docs/pt-BR/presets/no-nerd-font.md
new file mode 100644
index 000000000..a82a89b64
--- /dev/null
+++ b/docs/pt-BR/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Retornar para Personalizações](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuração
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Clique para baixar o TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/pt-BR/presets/no-runtimes.md b/docs/pt-BR/presets/no-runtimes.md
index b66d2ee64..70bc56620 100644
--- a/docs/pt-BR/presets/no-runtimes.md
+++ b/docs/pt-BR/presets/no-runtimes.md
@@ -2,9 +2,9 @@
# Remover versão do runtime
-Está personalização oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, este é 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ê!
-
+
### Configuração
diff --git a/docs/pt-BR/presets/tokyo-night.md b/docs/pt-BR/presets/tokyo-night.md
new file mode 100644
index 000000000..f7c02c4a8
--- /dev/null
+++ b/docs/pt-BR/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Retornar para Personalizações](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Pré-requisitos
+
+- Uma fonte [Nerd Font](https://www.nerdfonts.com/) instalada e ativada em seu terminal
+
+### Configuração
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Clique para baixar o TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/pt-PT/advanced-config/README.md b/docs/pt-PT/advanced-config/README.md
index 3e45a8876..9a8b0fffa 100644
--- a/docs/pt-PT/advanced-config/README.md
+++ b/docs/pt-PT/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ If multiple colors are specified for foreground/background, the last one in the
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md
index e9f968901..63a5e67b7 100644
--- a/docs/pt-PT/config/README.md
+++ b/docs/pt-PT/config/README.md
@@ -15,15 +15,17 @@ All configuration for starship is done in this [TOML](https://github.com/toml-la
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+For example:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
@@ -80,9 +138,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
For example:
-- `$version` is a format string with a variable named `version`.
-- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
-- `$git_branch $git_commit` has the two variables separated with a space.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Text Group
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
For example:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
For example:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ This is the list of prompt-wide configuration options.
| Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Example
@@ -178,10 +213,10 @@ This is the list of prompt-wide configuration options.
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Example
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
-| `full_symbol` | `" "` | The symbol shown when the battery is full. |
-| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
-| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
-| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | The symbol shown when the battery is full. |
+| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
+| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -423,9 +478,9 @@ The `battery` module shows how charged the device's battery is and its current c
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery Display
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The `display` option is an array of the following table.
| Option | Default | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `style` | `"red bold"` | The style used if the display option is in use. |
+| `style` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Example
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `'bold red'` | The style for the module. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | The style for the module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | The style for the module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | The style for the module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
-| `symbol` | `"🅒 "` | The symbol used before the environment name. |
-| `style` | `"bold green"` | The style for the module. |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | The symbol used before the environment name. |
+| `style` | `'bold green'` | The style for the module. |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | The style for the module. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | The style for the module. |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | The style for the module. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `style` | `"bold cyan"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | The style for the module. |
+| `style` | `'green bold'` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
-| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `style` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | Default | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
+| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `style` | `'bold cyan'` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Variable | Example | Description |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Variable | Example | Description |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Please check out these previous works that helped inspire the creation of starsh
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/pt-PT/presets/README.md b/docs/pt-PT/presets/README.md
index 26c2314bf..cb3dcf1bc 100644
--- a/docs/pt-PT/presets/README.md
+++ b/docs/pt-PT/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/pt-PT/presets/no-empty-icons.md b/docs/pt-PT/presets/no-empty-icons.md
new file mode 100644
index 000000000..7be6867d1
--- /dev/null
+++ b/docs/pt-PT/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuration
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/pt-PT/presets/no-nerd-font.md b/docs/pt-PT/presets/no-nerd-font.md
new file mode 100644
index 000000000..b154a6c00
--- /dev/null
+++ b/docs/pt-PT/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuration
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/pt-PT/presets/tokyo-night.md b/docs/pt-PT/presets/tokyo-night.md
new file mode 100644
index 000000000..33f517491
--- /dev/null
+++ b/docs/pt-PT/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Prerequisites
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
+
+### Configuration
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/ru-RU/advanced-config/README.md b/docs/ru-RU/advanced-config/README.md
index 78672a7f1..a7a3011d2 100644
--- a/docs/ru-RU/advanced-config/README.md
+++ b/docs/ru-RU/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
+
+Note: Nushell 0.71.0 or later is required
### Пример
@@ -280,5 +282,5 @@ continuation_prompt = "▶▶"
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md
index be5ae2bb8..a7e6fe1cd 100644
--- a/docs/ru-RU/config/README.md
+++ b/docs/ru-RU/config/README.md
@@ -15,15 +15,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
По традициям, большинство модулей имеют префикс цвета терминала по умолчанию (например, `через` в "узлах") и пустое пространство как суффикс.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+Например:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Форматирование строк
Формат строк - это формат, с которым модуль печатает все переменные. Большинство модулей имеют запись `формата`, который настраивает формат отображения модуля. Вы можете использовать тексты, переменные и группы текста в строке формата.
@@ -80,9 +138,9 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Например:
-- `$version` это строка формата с именем `версии`.
-- `$git_branch$git_commit` это строка формата с двумя переменными `git_branch` и `git_commit`.
-- `$git_branch $git_commit` имеет две переменные, разделенные пробелом.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Группа текста
@@ -94,20 +152,20 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Например:
-- `[on](red bold)` будет печатать строку `on` жирным текстом красного цвета.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` будет печатать `a b c` с `b` красного и `a` и `c` зеленого цвета соответсвенно.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Строки стиля
В Starship, большинство модулей позволяют настроить стили отображения. Это делается записью (обычно называется `style`), которая представляет собой строку, определяющую конфигурацию. Ниже приведены несколько примеров стилей строк, а также, их действия. Подробнее о полном синтаксисе можно прочитать в [расширенном разделе конфигурации](/advanced-config/).
-- `"fg:green bg:blue"` устанавливает зеленый текст на синем фоне
-- `"bg:blue fg:bright-green"` устанавливает ярко-зеленый текст на синем фоне
-- `"bold fg:27"` устанавливает жирный текст с [цветом ANSI](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` устанавливает подчёркиваемый текст цвета сожженного апельсина
-- `"bold italic fg:purple"` устанавливает жирный фиолетовый текст
-- `""` выключает все стили
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Обратите внимание на то, что, вид стиля зависит от вашего эмулятора терминала. Например, некоторые эмуляторы терминала будут использовать яркие цвета вместо жирного текста, и некоторые цветовые темы используют одинаковые значение для обычных и ярких цветов. Также, чтобы получить курсивный текст, ваш терминал должен поддерживать курсив.
@@ -117,43 +175,20 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Например:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(некоторый текст)` всегда не показывает ничего, поскольку в скобках нет переменных.
-- Когда `$all` является ярлыком для `\[$a$b\]`, `($all)` будет показываться только если `$a` и `$b` не являются `None`. Это работает так же, как `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-Например, когда вы хотите напечатать символ `$` на новой строке, следующие настройки для `формата` эквивалентны:
-
-```toml
-# с базовой строкой
-format = "\n\\$"
-
-# с многолинейной строкой
-format = """
-
-\\$"""
-
-# со строкой, состоящей из литералов
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Командная строка
@@ -165,11 +200,11 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
| Параметр | По умолчанию | Описание |
| ----------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [ссылка](#default-prompt-format) | Настройка форматирования оболочки. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Тайм-аут запуска сканирования файлов (в миллисекундах). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Пример
@@ -177,27 +212,27 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
```toml
# ~/.config/starship.toml
-# Собственное форматирование оболочки
-format = """
+# Use custom format
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
-# Подождите 10 милисекунд пока starship прочитает файлы в этой директории.
+# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Формат оболочки по умолчанию
@@ -205,7 +240,7 @@ mustard = "#af8700"
Формат по умолчанию `format` используется для определения формата подсказки (prompt), если `format` пустой или отсутствует. Значение по умолчанию:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Формат модуля. |
-| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. |
-| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | Стиль модуля. |
+| `symbol` | `'☁️ '` | Символ перед отображением текущего профиля AWS. |
+| `region_aliases` | `{}` | Таблица региона псевдонимов, отображаемая вместе с именем AWS. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | Стиль модуля. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Отключение модуля `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Отобразить профиль
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Опции
| Переменная | По умолчанию | Описание |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Пример
+### Примеры
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ style = "blue bold"
| Параметр | По умолчанию | Описание |
| -------------------- | --------------------------------- | ------------------------------------------------------- |
-| `full_symbol` | `" "` | Символ, отображаемый при полной батарее. |
-| `charging_symbol` | `" "` | Символ, показываемый при зарядке аккумулятора. |
-| `discharging_symbol` | `" "` | Символ, показываемый при разрядке аккумулятора. |
-| `unknown_symbol` | `" "` | Символ, отображаемый при неизвестном состоянии батареи. |
-| `empty_symbol` | `" "` | Символ, отображаемый при пустом состоянии батареи. |
-| `format` | `"[$symbol$percentage]($style) "` | Формат модуля. |
+| `full_symbol` | `' '` | Символ, отображаемый при полной батарее. |
+| `charging_symbol` | `' '` | Символ, показываемый при зарядке аккумулятора. |
+| `discharging_symbol` | `' '` | Символ, показываемый при разрядке аккумулятора. |
+| `unknown_symbol` | `' '` | Символ, отображаемый при неизвестном состоянии батареи. |
+| `empty_symbol` | `' '` | Символ, отображаемый при пустом состоянии батареи. |
+| `format` | `'[$symbol$percentage]($style) '` | Формат модуля. |
| `display` | [ссылка](#battery-display) | Порог отображения и стиль для модуля. |
| `disabled` | `false` | Отключает модуль `battery`. |
@@ -423,9 +478,9 @@ style = "blue bold"
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Отображение батареи
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r
| Параметр | По умолчанию | Описание |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | Верхняя граница опции отображения. |
-| `style` | `"red bold"` | Используемый стиль, если используется опция отображения. |
+| `style` | `'red bold'` | Используемый стиль, если используется опция отображения. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Пример
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | Стиль модуля. |
+| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `elixir`. |
### Переменные
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | Стиль модуля. |
+| `style` | `'bold red'` | Стиль модуля. |
| `disabled` | `false` | Disables the `bun` module. |
### Переменные
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Параметр | По умолчанию | Описание |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | Стиль модуля. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | Стиль модуля. |
| `disabled` | `false` | Disables the `c` module. |
### Переменные
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Символ
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Параметр | По умолчанию | Описание |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Отключает модуль `character`. |
### Переменные
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"△ "` | The symbol used before the version of cmake. |
+| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'△ '` | The symbol used before the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | Стиль модуля. |
+| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `cmake` module. |
### Переменные
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | Стиль модуля. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | Стиль модуля. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Кратчайшая продолжительность для показа времени (в миллисекундах). |
| `show_milliseconds` | `false` | Показывать миллисекунды в дополнение к секундам в продолжительности. |
-| `format` | `"took [$duration]($style) "` | Формат модуля. |
-| `style` | `"bold yellow"` | Стиль модуля. |
+| `format` | `'took [$duration]($style) '` | Формат модуля. |
+| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `cmd_duration`. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,14 +813,14 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Конда
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
-::: tip Подсказка
+::: tip
Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`.
@@ -776,9 +831,9 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `truncation_length` | `1` | Количество каталогов, в которых путь к окружению должен быть усечен, если окружение было создано через `conda create -p [path]`. `0` означает без усечения. Также смотрите модуль [`directory`](#directory). |
-| `symbol` | `"🅒 "` | Символ перед названием окружения. |
-| `style` | `"bold green"` | Стиль модуля. |
-| `format` | `"via [$symbol$environment]($style) "` | Формат модуля. |
+| `symbol` | `'🅒 '` | Символ перед названием окружения. |
+| `style` | `'bold green'` | Стиль модуля. |
+| `format` | `'via [$symbol$environment]($style) '` | Формат модуля. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Отключает модуль `conda`. |
@@ -798,7 +853,7 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Параметр | По умолчанию | Описание |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | Стиль модуля. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | Стиль модуля. |
| `format` | `'[$symbol \[$name\]]($style) '` | Формат модуля. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | Стиль модуля. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | Символ, используемый перед отображением версии crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | Стиль модуля. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Отключает модуль `crystal`. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `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 Daml |
-| `style` | `"bold cyan"` | Стиль модуля. |
+| `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 Daml |
+| `style` | `'bold cyan'` | Стиль модуля. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
-| `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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | Стиль модуля. |
+| `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 Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `dart` module. |
### Переменные
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | Стиль модуля. |
+| `style` | `'green bold'` | Стиль модуля. |
| `disabled` | `false` | Disables the `deno` module. |
### Переменные
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Каталог
@@ -996,20 +1051,21 @@ format = "via [🦕 $version](green bold) "
### Опции
-| Параметр | По умолчанию | Описание |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | Количество родительских папок, к которым должен быть усечен текущий каталог. |
-| `truncate_to_repo` | `true` | Следует или нет обрезать до корня репозитория git, в котором вы находитесь. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Формат модуля. |
-| `style` | `"bold cyan"` | Стиль модуля. |
-| `disabled` | `false` | Отключает модуль `directory`. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Параметр | По умолчанию | Описание |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | Количество родительских папок, к которым должен быть усечен текущий каталог. |
+| `truncate_to_repo` | `true` | Следует или нет обрезать до корня репозитория git, в котором вы находитесь. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | Формат модуля. |
+| `style` | `'bold cyan'` | Стиль модуля. |
+| `disabled` | `false` | Отключает модуль `directory`. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога.
@@ -1024,8 +1080,8 @@ format = "via [🦕 $version](green bold) "
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` взаимодействует со стандартными параметрами усечения, которые могут сначала показаться странными: если он не равен нулю, элементы пути, который обычно усекается, вместо этого отображаются с указанным количеством символов. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ format = "via [🦕 $version](green bold) "
| Переменная | Пример | Описание |
| ---------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Отражает значение параметра `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Переменная | Пример | Описание |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Отражает значение параметра `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Отражает значение параметра `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ If you're looking to further customize Starship:
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/ru-RU/presets/README.md b/docs/ru-RU/presets/README.md
index 5c66c31e6..b34a9c4ee 100644
--- a/docs/ru-RU/presets/README.md
+++ b/docs/ru-RU/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/ru-RU/presets/no-empty-icons.md b/docs/ru-RU/presets/no-empty-icons.md
new file mode 100644
index 000000000..929dce1c8
--- /dev/null
+++ b/docs/ru-RU/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Конфигурация
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/ru-RU/presets/no-nerd-font.md b/docs/ru-RU/presets/no-nerd-font.md
new file mode 100644
index 000000000..e2b81f06c
--- /dev/null
+++ b/docs/ru-RU/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Конфигурация
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/ru-RU/presets/tokyo-night.md b/docs/ru-RU/presets/tokyo-night.md
new file mode 100644
index 000000000..1da21ad5c
--- /dev/null
+++ b/docs/ru-RU/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Обязательные требования
+
+- Установленный и включенный шрифт [Nerd Font](https://www.nerdfonts.com/) в вашем терминале
+
+### Конфигурация
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/tr-TR/advanced-config/README.md b/docs/tr-TR/advanced-config/README.md
index d4b633cd0..f4de2506a 100644
--- a/docs/tr-TR/advanced-config/README.md
+++ b/docs/tr-TR/advanced-config/README.md
@@ -204,7 +204,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -279,5 +281,5 @@ If multiple colors are specified for foreground/background, the last one in the
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md
index 18cb513f8..a67909fe7 100644
--- a/docs/tr-TR/config/README.md
+++ b/docs/tr-TR/config/README.md
@@ -15,15 +15,17 @@ All configuration for starship is done in this [TOML](https://github.com/toml-la
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+For example:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
@@ -80,9 +138,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
For example:
-- `$version` is a format string with a variable named `version`.
-- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
-- `$git_branch $git_commit` has the two variables separated with a space.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Text Group
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
For example:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
For example:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ This is the list of prompt-wide configuration options.
| Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Example
@@ -178,10 +213,10 @@ This is the list of prompt-wide configuration options.
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `stil` | `"bold yellow"` | The style for the module. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `stil` | `'bold yellow'` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `stil` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `stil` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Example
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
-| `full_symbol` | `" "` | The symbol shown when the battery is full. |
-| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
-| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
-| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | The symbol shown when the battery is full. |
+| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
+| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -423,9 +478,9 @@ The `battery` module shows how charged the device's battery is and its current c
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery Display
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The `display` option is an array of the following table.
| Option | Default | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `stil` | `"red bold"` | The style used if the display option is in use. |
+| `stil` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Example
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `stil` | `"bold blue"` | The style for the module. |
+| `stil` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `stil` | `"bold red"` | The style for the module. |
+| `stil` | `'bold red'` | The style for the module. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `stil` | `"bold 149"` | The style for the module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `stil` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `stil` | `"bold blue"` | The style for the module. |
+| `stil` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `stil` | `"bold blue"` | The style for the module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `stil` | `'bold blue'` | The style for the module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `stil` | `"bold yellow"` | The style for the module. |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `stil` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
-| `symbol` | `"🅒 "` | The symbol used before the environment name. |
-| `stil` | `"bold green"` | The style for the module. |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | The symbol used before the environment name. |
+| `stil` | `'bold green'` | The style for the module. |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `stil` | `"bold red dimmed"` | The style for the module. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `stil` | `'bold red dimmed'` | The style for the module. |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `stil` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `stil` | `'bold red'` | The style for the module. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `stil` | `"bold cyan"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `stil` | `'bold cyan'` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `stil` | `"bold blue"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `stil` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `stil` | `"green bold"` | The style for the module. |
+| `stil` | `'green bold'` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
-| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `stil` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | Default | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
+| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `stil` | `'bold cyan'` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Variable | Example | Description |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Variable | Example | Description |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| stil | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| stil | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Lütfen starship'in oluşmasında ilham kaynağı olan çalışmalara da göz at
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/tr-TR/presets/README.md b/docs/tr-TR/presets/README.md
index 77ce81921..1880a1330 100644
--- a/docs/tr-TR/presets/README.md
+++ b/docs/tr-TR/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/tr-TR/presets/no-empty-icons.md b/docs/tr-TR/presets/no-empty-icons.md
new file mode 100644
index 000000000..986e8fbab
--- /dev/null
+++ b/docs/tr-TR/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Yapılandırma
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/tr-TR/presets/no-nerd-font.md b/docs/tr-TR/presets/no-nerd-font.md
new file mode 100644
index 000000000..0d4f7b86a
--- /dev/null
+++ b/docs/tr-TR/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Yapılandırma
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/tr-TR/presets/tokyo-night.md b/docs/tr-TR/presets/tokyo-night.md
new file mode 100644
index 000000000..ecb1e27eb
--- /dev/null
+++ b/docs/tr-TR/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Ön koşullar
+
+- Terminalinizde bir [Nerd Font](https://www.nerdfonts.com/) yüklü ve etkin olmalı
+
+### Yapılandırma
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/uk-UA/README.md b/docs/uk-UA/README.md
index 57692d1ad..e5ea61d2f 100644
--- a/docs/uk-UA/README.md
+++ b/docs/uk-UA/README.md
@@ -36,6 +36,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
1. Install the **starship** binary:
+
#### Install Latest Version
With Shell:
@@ -46,6 +47,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
+
#### Install via Package Manager
With [Homebrew](https://brew.sh/):
@@ -61,9 +63,10 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
1. Add the init script to your shell's config file:
+
#### Bash
- Add the following to the end of `~/.bashrc`:
+ Додайте наступний рядок наприкінці `~/.bashrc`:
```sh
# ~/.bashrc
@@ -71,9 +74,10 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
eval "$(starship init bash)"
```
+
#### Fish
- Add the following to the end of `~/.config/fish/config.fish`:
+ Додайте наступний рядок наприкінці `~/.config/fish/config.fish`:
```sh
# ~/.config/fish/config.fish
@@ -81,9 +85,10 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
starship init fish | source
```
+
#### Zsh
- Add the following to the end of `~/.zshrc`:
+ Додайте наступний рядок наприкінці `~/.zshrc`:
```sh
# ~/.zshrc
@@ -91,6 +96,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
eval "$(starship init zsh)"
```
+
#### Powershell
Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
@@ -99,9 +105,10 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
Invoke-Expression (&starship init powershell)
```
+
#### Ion
- Add the following to the end of `~/.config/ion/initrc`:
+ Додайте наступний рядок наприкінці `~/.config/ion/initrc`:
```sh
# ~/.config/ion/initrc
@@ -109,6 +116,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
eval $(starship init ion)
```
+
#### Elvish
::: warning
@@ -117,7 +125,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
:::
- Add the following to the end of `~/.elvish/rc.elv`:
+ Додайте наступний рядок наприкінці `~/.elvish/rc.elv`:
```sh
# ~/.elvish/rc.elv
@@ -125,9 +133,10 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
eval (starship init elvish)
```
+
#### Tcsh
- Add the following to the end of `~/.tcshrc`:
+ Додайте наступний рядок наприкінці `~/.tcshrc`:
```sh
# ~/.tcshrc
@@ -135,6 +144,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
eval `starship init tcsh`
```
+
#### Nushell
::: warning
@@ -149,7 +159,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
starship init nu | save ~/.cache/starship/init.nu
```
- And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
+ Додайте наступний рядок наприкінці Вашої конфігурації Nushell (знайдіть її виконавши `$nu.config-path`):
```sh
source ~/.cache/starship/init.nu
@@ -157,7 +167,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Xonsh
- Add the following to the end of `~/.xonshrc`:
+ Додайте наступний рядок наприкінці `~/.xonshrc`:
```sh
# ~/.xonshrc
@@ -165,9 +175,10 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
execx($(starship init xonsh))
```
+
#### 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:
+ Вам потрібно використовувати [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) разом з Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
```lua
-- starship.lua
diff --git a/docs/uk-UA/advanced-config/README.md b/docs/uk-UA/advanced-config/README.md
index 3e45a8876..9a8b0fffa 100644
--- a/docs/uk-UA/advanced-config/README.md
+++ b/docs/uk-UA/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`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
@@ -280,5 +282,5 @@ If multiple colors are specified for foreground/background, the last one in the
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/uk-UA/config/README.md b/docs/uk-UA/config/README.md
index 7a6657534..63a5e67b7 100644
--- a/docs/uk-UA/config/README.md
+++ b/docs/uk-UA/config/README.md
@@ -15,15 +15,17 @@ All configuration for starship is done in this [TOML](https://github.com/toml-la
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+For example:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
@@ -80,9 +138,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
For example:
-- `$version` is a format string with a variable named `version`.
-- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
-- `$git_branch $git_commit` has the two variables separated with a space.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Text Group
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
For example:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
-- `"fg:green bg:blue"` sets green text on a blue background
-- `"bg:blue fg:bright-green"` sets bright green text on a blue background
-- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
-- `"bold italic fg:purple"` sets bold italic purple text
-- `""` explicitly disables all styling
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
For example:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ This is the list of prompt-wide configuration options.
| Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Example
@@ -178,10 +213,10 @@ This is the list of prompt-wide configuration options.
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,28 +344,30 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| Option | Default | Description |
+| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
-| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | The style for the module. |
-| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
-| `disabled` | `false` | Disables the `AWS` module. |
-| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
+| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |
+| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | The style for the module. |
+| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
+| `disabled` | `false` | Disables the `AWS` module. |
+| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables
-| Variable | Example | Description |
-| -------- | ---------------- | ------------------------------------------- |
-| region | `ap-northeast-1` | The current AWS region |
-| profile | `astronauts` | The current AWS profile |
-| duration | `2h27m20s` | The temporary credentials validity duration |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ---------------- | ------------------------------------------- |
+| region | `ap-northeast-1` | The current AWS region |
+| profile | `astronauts` | The current AWS profile |
+| duration | `2h27m20s` | The temporary credentials validity duration |
+| 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
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Options
| Variable | Default | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Example
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ The `battery` module shows how charged the device's battery is and its current c
| Option | Default | Description |
| -------------------- | --------------------------------- | --------------------------------------------------- |
-| `full_symbol` | `" "` | The symbol shown when the battery is full. |
-| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
-| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
-| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
-| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | The symbol shown when the battery is full. |
+| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
+| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
@@ -423,9 +478,9 @@ The `battery` module shows how charged the device's battery is and its current c
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery Display
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The `display` option is an array of the following table.
| Option | Default | Description |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. |
-| `style` | `"red bold"` | The style used if the display option is in use. |
+| `style` | `'red bold'` | The style used if the display option is in use. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Example
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,22 +571,22 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | The style for the module. |
+| `style` | `'bold red'` | The style for the module. |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
-| Variable | Example | Description |
-| -------- | -------- | ------------------------------------ |
-| version | `v0.1.4` | The version of `bun` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | -------- | ------------------------------------ |
+| version | `v0.1.4` | The version of `bun` |
+| 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
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | Default | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | The style for the module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,22 +723,22 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | The style for the module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
-| Variable | Example | Description |
-| -------- | --------- | ------------------------------------ |
-| version | `v3.17.3` | The version of cmake |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | --------- | ------------------------------------ |
+| version | `v3.17.3` | The version of cmake |
+| 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
@@ -698,22 +753,22 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | The style for the module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | The style for the module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
### Variables
-| Variable | Example | Description |
-| -------- | ---------- | ------------------------------------ |
-| version | `v3.1.2.0` | The version of `cobol` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ---------- | ------------------------------------ |
+| version | `v3.1.2.0` | The version of `cobol` |
+| 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
@@ -735,8 +790,8 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -744,10 +799,10 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
### Variables
-| Variable | Example | Description |
-| -------- | -------- | --------------------------------------- |
-| duration | `16m40s` | The time it took to execute the command |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | -------- | --------------------------------------- |
+| duration | `16m40s` | The time it took to execute the command |
+| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -758,7 +813,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | Default | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
-| `symbol` | `"🅒 "` | The symbol used before the environment name. |
-| `style` | `"bold green"` | The style for the module. |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | The symbol used before the environment name. |
+| `style` | `'bold green'` | The style for the module. |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
@@ -788,7 +843,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| ----------- | ------------ | ------------------------------------ |
| environment | `astronauts` | The current conda environment |
| symbol | | Mirrors the value of option `symbol` |
-| 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
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -807,20 +862,20 @@ The `container` module displays a symbol and container name, if inside a contain
### Options
-| Option | Default | Description |
-| ---------- | -------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | The style for the module. |
+| Option | Default | Description |
+| ---------- | ---------------------------------- | ----------------------------------------- |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | The style for the module. |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
-| `disabled` | `false` | Disables the `container` module. |
+| `disabled` | `false` | Disables the `container` module. |
### Variables
-| Variable | Example | Description |
-| -------- | ------------------- | ------------------------------------ |
-| name | `fedora-toolbox:35` | The name of the container |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ------------------- | ------------------------------------ |
+| name | `fedora-toolbox:35` | The name of the container |
+| 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
@@ -844,22 +899,22 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | The style for the module. |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables
-| Variable | Example | Description |
-| -------- | --------- | ------------------------------------ |
-| version | `v0.32.1` | The version of `crystal` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | --------- | ------------------------------------ |
+| version | `v0.32.1` | The version of `crystal` |
+| 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
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,22 +937,22 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `style` | `"bold cyan"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
-| Variable | Example | Description |
-| -------- | -------- | ------------------------------------ |
-| version | `v2.2.0` | The version of `daml` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | -------- | ------------------------------------ |
+| version | `v2.2.0` | The version of `daml` |
+| 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
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,22 +977,22 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
-| Variable | Example | Description |
-| -------- | -------- | ------------------------------------ |
-| version | `v2.8.4` | The version of `dart` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | -------- | ------------------------------------ |
+| version | `v2.8.4` | The version of `dart` |
+| 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
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,22 +1015,22 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | The style for the module. |
+| `style` | `'green bold'` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
-| Variable | Example | Description |
-| -------- | -------- | ------------------------------------ |
-| version | `v1.8.3` | The version of `deno` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | -------- | ------------------------------------ |
+| version | `v1.8.3` | The version of `deno` |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | | Mirrors the value of option `style` |
### Example
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
-| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `style` | `"bold cyan"` | The style for the module. |
-| `disabled` | `false` | Disables the `directory` module. |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | Default | Description |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
+| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `style` | `'bold cyan'` | The style for the module. |
+| `disabled` | `false` | Disables the `directory` module. |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed.
@@ -1024,8 +1080,8 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1034,10 +1090,10 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Variables
-| Variable | Example | Description |
-| -------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | --------------------- | ----------------------------------- |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1046,13 +1102,13 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
Let us consider the path `/path/to/home/git_repo/src/lib`
-| Variable | Example | Description |
-| ---------------- | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| Variable | Example | Description |
+| ------------------ | --------------------- | --------------------------------------- |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
| | The symbol used to separate pipestatus segments (supports formatting) |
+| Option | Default | Description |
+| --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `format` | `'[$symbol$status]($style) '` | The format of the module |
+| `symbol` | `'❌'` | The symbol displayed on program error |
+| `success_symbol` | `''` | The symbol displayed on program success |
+| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
+| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |
+| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |
+| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |
+| `style` | `'bold red'` | The style for the module. |
+| `recognize_signal_code` | `true` | Enable signal mapping from exit code |
+| `map_symbol` | `false` | Enable symbols mapping from exit code |
+| `pipestatus` | `false` | Enable pipestatus reporting |
+| `pipestatus_separator` | | | The symbol used to separate pipestatus segments (supports formatting) |
| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline |
-| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments |
-| `disabled` | `true` | Disables the `status` module. |
+| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments |
+| `disabled` | `true` | Disables the `status` module. |
### Variables
@@ -3310,7 +3571,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| maybe_int | `7` | Contains the exit code number when no meaning has been found |
| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format |
| symbol | | Mirrors the value of option `symbol` |
-| 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
@@ -3320,9 +3581,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml
[status]
-style = "bg:blue"
-symbol = "🔴 "
-success_symbol = "🟢 SUCCESS"
+style = 'bg:blue'
+symbol = '🔴 '
+success_symbol = '🟢 SUCCESS'
format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
@@ -3342,18 +3603,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Option | Default | Description |
| --------------- | ------------------------ | ------------------------------------------------------- |
-| `format` | `"[as $symbol]($style)"` | The format of the module |
-| `symbol` | `"🧙 "` | The symbol displayed when credentials are cached |
-| `style` | `"bold blue"` | The style for the module. |
+| `format` | `'[as $symbol]($style)'` | The format of the module |
+| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached |
+| `style` | `'bold blue'` | The style for the module. |
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Disables the `sudo` module. |
### Variables
-| Variable | Example | Description |
-| -------- | ------- | ------------------------------------ |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ------- | ------------------------------------ |
+| 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
@@ -3363,8 +3624,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
# ~/.config/starship.toml
[sudo]
-style = "bold green"
-symbol = "👩💻 "
+style = 'bold green'
+symbol = '👩💻 '
disabled = false
```
@@ -3388,22 +3649,22 @@ By default the `swift` module shows the currently installed version of [Swift](h
| 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 Swift |
-| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
-| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🐦 '` | A format string representing the symbol of Swift |
+| `detect_extensions` | `['swift']` | Which extensions should trigger this module. |
+| `detect_files` | `['Package.swift']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold 202"` | The style for the module. |
+| `style` | `'bold 202'` | The style for the module. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
-| Variable | Example | Description |
-| -------- | -------- | ------------------------------------ |
-| version | `v5.2.4` | The version of `swift` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | -------- | ------------------------------------ |
+| version | `v5.2.4` | The version of `swift` |
+| 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
@@ -3413,7 +3674,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
# ~/.config/starship.toml
[swift]
-format = "via [🏎 $version](red bold)"
+format = 'via [🏎 $version](red bold)'
```
## Terraform
@@ -3435,13 +3696,13 @@ By default the module will be shown if any of the following conditions are met:
| Option | Default | Description |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
-| `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
+| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
-| `style` | `"bold 105"` | The style for the module. |
+| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
+| `style` | `'bold 105'` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables
@@ -3451,7 +3712,7 @@ By default the module will be shown if any of the following conditions are met:
| version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | The current Terraform workspace |
| symbol | | Mirrors the value of option `symbol` |
-| 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
@@ -3463,7 +3724,7 @@ By default the module will be shown if any of the following conditions are met:
# ~/.config/starship.toml
[terraform]
-format = "[🏎💨 $version$workspace]($style) "
+format = '[🏎💨 $version$workspace]($style) '
```
#### Without Terraform version
@@ -3472,7 +3733,7 @@ format = "[🏎💨 $version$workspace]($style) "
# ~/.config/starship.toml
[terraform]
-format = "[🏎💨 $workspace]($style) "
+format = '[🏎💨 $workspace]($style) '
```
## Time
@@ -3487,24 +3748,24 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Options
-| Option | Default | Description |
-| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `format` | `"at [$time]($style) "` | The format string for the module. |
-| `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. |
-| `style` | `"bold yellow"` | The style for the module time |
-| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
-| `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 |
+| Option | Default | Description |
+| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `format` | `'at [$time]($style) '` | The format string for the module. |
+| `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. |
+| `style` | `'bold yellow'` | The style for the module time |
+| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
+| `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 |
-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.
### Variables
-| Variable | Example | Description |
-| -------- | ---------- | ----------------------------------- |
-| time | `13:08:10` | The current time. |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ---------- | ----------------------------------- |
+| time | `13:08:10` | The current time. |
+| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -3516,9 +3777,9 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
-time_format = "%T"
-utc_time_offset = "-5"
-time_range = "10:00:00-14:00:00"
+time_format = '%T'
+utc_time_offset = '-5'
+time_range = '10:00:00-14:00:00'
```
## Username
@@ -3540,9 +3801,9 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| Option | Default | Description |
| ------------- | ----------------------- | ------------------------------------------- |
-| `style_root` | `"bold red"` | The style used when the user is root/admin. |
-| `style_user` | `"bold yellow"` | The style used for non-root users. |
-| `format` | `"[$user]($style) in "` | The format for the module. |
+| `style_root` | `'bold red'` | The style used when the user is root/admin. |
+| `style_user` | `'bold yellow'` | The style used for non-root users. |
+| `format` | `'[$user]($style) in '` | The format for the module. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
@@ -3550,8 +3811,8 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| Variable | Example | Description |
| -------- | ------------ | ------------------------------------------------------------------------------------------- |
-| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
-| `user` | `"matchai"` | The currently logged-in user ID. |
+| `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
+| `user` | `'matchai'` | The currently logged-in user ID. |
### Example
@@ -3559,9 +3820,9 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
# ~/.config/starship.toml
[username]
-style_user = "white bold"
-style_root = "black bold"
-format = "user: [$user]($style) "
+style_user = 'white bold'
+style_root = 'black bold'
+format = 'user: [$user]($style) '
disabled = false
show_always = true
```
@@ -3576,22 +3837,22 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
| 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 Vagrant. |
+| `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 Vagrant. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
+| `detect_files` | `['Vagrantfile']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"cyan bold"` | The style for the module. |
+| `style` | `'cyan bold'` | The style for the module. |
| `disabled` | `false` | Disables the `vagrant` module. |
### Variables
-| Variable | Example | Description |
-| -------- | ---------------- | ------------------------------------ |
-| version | `Vagrant 2.2.10` | The version of `Vagrant` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ---------------- | ------------------------------------ |
+| version | `Vagrant 2.2.10` | The version of `Vagrant` |
+| 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
@@ -3601,7 +3862,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
# ~/.config/starship.toml
[vagrant]
-format = "via [⍱ $version](bold white) "
+format = 'via [⍱ $version](bold white) '
```
## V
@@ -3615,29 +3876,29 @@ The `vlang` module shows you your currently installed version of [V](https://vla
| 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` | `"V "` | A format string representing the symbol of V |
-| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
-| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'V '` | A format string representing the symbol of V |
+| `detect_extensions` | `['v']` | Which extensions should trigger this module. |
+| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"blue bold"` | The style for the module. |
+| `style` | `'blue bold'` | The style for the module. |
| `disabled` | `false` | Disables the `vlang` module. |
### Variables
-| Variable | Example | Description |
-| -------- | ------- | ------------------------------------ |
-| version | `v0.2` | The version of `v` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ------- | ------------------------------------ |
+| version | `v0.2` | The version of `v` |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[vlang]
-format = "via [V $version](blue bold) "
+format = 'via [V $version](blue bold) '
```
## VCSH
@@ -3648,18 +3909,18 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
| Option | Default | Description |
| ---------- | -------------------------------- | ------------------------------------------------------ |
-| `symbol` | | The symbol used before displaying the repository name. |
-| `style` | `"bold yellow"` | The style for the module. |
-| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. |
+| `symbol` | `''` | The symbol used before displaying the repository name. |
+| `style` | `'bold yellow'` | The style for the module. |
+| `format` | `'vcsh [$symbol$repo]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `vcsh` module. |
### Variables
-| Variable | Example | Description |
-| -------- | ------------------------------------------- | ------------------------------------ |
-| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | `black bold dimmed` | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ------------------------------------------- | ------------------------------------ |
+| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | `black bold dimmed` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -3669,7 +3930,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
# ~/.config/starship.toml
[vcsh]
-format = "[🆅 $repo](bold blue) "
+format = '[🆅 $repo](bold blue) '
```
## Zig
@@ -3682,22 +3943,22 @@ By default the the `zig` module shows the currently installed version of [Zig](h
| 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 Zig. |
-| `style` | `"bold yellow"` | The style for the module. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. |
+| `style` | `'bold yellow'` | The style for the module. |
| `disabled` | `false` | Disables the `zig` module. |
-| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
+| `detect_extensions` | `['zig']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables
-| Variable | Example | Description |
-| -------- | -------- | ------------------------------------ |
-| version | `v0.6.0` | The version of `zig` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | -------- | ------------------------------------ |
+| version | `v0.6.0` | The version of `zig` |
+| 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
@@ -3707,7 +3968,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
# ~/.config/starship.toml
[zig]
-symbol = "⚡️ "
+symbol = '⚡️ '
```
## Custom commands
@@ -3752,16 +4013,16 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| Option | Default | Description |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `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. |
| `shell` | | [See below](#custom-command-shell) |
-| `description` | `"Android
@@ -210,20 +210,19 @@ curl -sS https://starship.rs/install.sh | sh
Як варіант, можете встановити Starship через будь-який з наступних пакетних менеджерів:
-| Дистрибутив | Репозиторій | Командна інструкція |
-| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
-| **_Будь-який_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
-| _Будь-який_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
-| _Будь-який_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
-| _Будь-який_ | [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` |
-| Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` |
+| Дистрибутив | Репозиторій | Командна інструкція |
+| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
+| **_Будь-який_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
+| _Будь-який_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
+| _Будь-який_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
+| _Будь-який_ | [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` |
+| 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`
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
-| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
-| Manjaro | | `pacman -S starship` |
-| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
-| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
+| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
+| Manjaro | | `pacman -S starship` |
+| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
+| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
Bash
-Add the following to the end of `~/.bashrc`:
+Додайте наступний рядок наприкінці `~/.bashrc`:
```sh
eval "$(starship init bash)"
@@ -282,7 +281,7 @@ eval "$(starship init bash)"
Cmd
-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:
+Вам потрібно використовувати [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) разом з Cmd. Створіть файл за шляхом `%LocalAppData%\clink\starship.lua` із наступним вмістом:
```lua
load(io.popen('starship init cmd'):read("*a"))()
@@ -293,20 +292,20 @@ load(io.popen('starship init cmd'):read("*a"))()
Elvish
-Add the following to the end of `~/.elvish/rc.elv`:
+Додайте наступний рядок наприкінці `~/.elvish/rc.elv`:
```sh
eval (starship init elvish)
```
-Note: Only Elvish v0.18+ is supported
+Примітка: Підтримується лише Elvish v0.18+
Fish
-Add the following to the end of `~/.config/fish/config.fish`:
+Додайте наступний рядок наприкінці `~/.config/fish/config.fish`:
```fish
starship init fish | source
@@ -317,7 +316,7 @@ starship init fish | source
Ion
-Add the following to the end of `~/.config/ion/initrc`:
+Додайте наступний рядок наприкінці `~/.config/ion/initrc`:
```sh
eval $(starship init ion)
@@ -335,20 +334,20 @@ mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
```
-And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
+Додайте наступний рядок наприкінці Вашої конфігурації Nushell (знайдіть її виконавши `$nu.config-path`):
```sh
source ~/.cache/starship/init.nu
```
-Note: Only Nushell v0.61+ is supported
+Примітка: Підтримується лише Nushell v0.61+
PowerShell
-Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):
+Додайте наступний рядок наприкінці Вашої конфігурації PowerShell (знайдіть її виконавши `$PROFILE`):
```powershell
Invoke-Expression (&starship init powershell)
@@ -359,7 +358,7 @@ Invoke-Expression (&starship init powershell)
Tcsh
-Add the following to the end of `~/.tcshrc`:
+Додайте наступний рядок наприкінці `~/.tcshrc`:
```sh
eval `starship init tcsh`
@@ -370,7 +369,7 @@ eval `starship init tcsh`
Xonsh
-Add the following to the end of `~/.xonshrc`:
+Додайте наступний рядок наприкінці `~/.xonshrc`:
```python
execx($(starship init xonsh))
@@ -381,7 +380,7 @@ execx($(starship init xonsh))
Zsh
-Add the following to the end of `~/.zshrc`:
+Додайте наступний рядок наприкінці `~/.zshrc`:
```sh
eval "$(starship init zsh)"
@@ -389,7 +388,7 @@ eval "$(starship init zsh)"
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.
diff --git a/docs/uk-UA/installing/README.md b/docs/uk-UA/installing/README.md
index 994c58f1c..a20c891a1 100644
--- a/docs/uk-UA/installing/README.md
+++ b/docs/uk-UA/installing/README.md
@@ -1,21 +1,21 @@
-# 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
-For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
+Для більшості користувачів чудово підійдуть інструкції на [головній сторінці](/guide/#🚀-installation). Однак, для деяких більш спеціалізованих платформ потрібні інші інструкції.
-There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
+Існує так багато платформ, що вони не вписуються в основний файл README.md, тож ось деякі інструкції зі встановлення від спільноти для інших платформ. Вашої тут немає? Будь ласка, додайте її сюди, якщо дізнаєтесь!
## [Chocolatey](https://chocolatey.org)
### Передумови
-Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
+Перейдіть на [сторінку встановлення Chocolatey](https://chocolatey.org/install) та дотримуйтесь інструкцій, щоб установити Chocolatey.
-### Installation
+### Установлення
```powershell
choco install starship
@@ -29,7 +29,7 @@ choco install starship
pkg install getconf
```
-### Installation
+### Установлення
```sh
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin
@@ -37,9 +37,9 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term
## [Funtoo Linux](https://www.funtoo.org/Welcome)
-### Installation
+### Установлення
-On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage:
+У Funtoo Linux starship можна встановити з [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) через Portage:
```sh
emerge app-shells/starship
@@ -47,17 +47,17 @@ emerge app-shells/starship
## [Nix](https://nixos.wiki/wiki/Nix)
-### Getting the Binary
+### Завантаження бінарного файлу
-#### Imperatively
+#### Імперативно
```sh
nix-env -iA nixos.starship
```
-#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
+#### Декларативно, для одного користувача, через [home-manager](https://github.com/nix-community/home-manager)
-Enable the `programs.starship` module in your `home.nix` file, and add your settings
+Увімкніть модуль `programs.starship` у Вашому файлі `home.nix` та додайте ваші налаштування
```nix
{
@@ -78,15 +78,15 @@ Enable the `programs.starship` module in your `home.nix` file, and add your sett
}
```
-then run
+потім виконайте
```sh
home-manager switch
```
-#### Declarative, system-wide, with NixOS
+#### Декларативно, для цілої системи, з NixOS
-Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run
+Додайте `pkgs.starship` до `environment.systemPackages` у Вашій `configuration.nix`, після чого виконайте
```sh
sudo nixos-rebuild switch
diff --git a/docs/uk-UA/presets/README.md b/docs/uk-UA/presets/README.md
index 26c2314bf..cb3dcf1bc 100644
--- a/docs/uk-UA/presets/README.md
+++ b/docs/uk-UA/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/uk-UA/presets/no-empty-icons.md b/docs/uk-UA/presets/no-empty-icons.md
new file mode 100644
index 000000000..7be6867d1
--- /dev/null
+++ b/docs/uk-UA/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Configuration
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/uk-UA/presets/no-nerd-font.md b/docs/uk-UA/presets/no-nerd-font.md
new file mode 100644
index 000000000..b154a6c00
--- /dev/null
+++ b/docs/uk-UA/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Configuration
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/uk-UA/presets/tokyo-night.md b/docs/uk-UA/presets/tokyo-night.md
new file mode 100644
index 000000000..1dbc02ead
--- /dev/null
+++ b/docs/uk-UA/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Передумови
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
+
+### Configuration
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/vi-VN/advanced-config/README.md b/docs/vi-VN/advanced-config/README.md
index 859db966f..b7c6cb51c 100644
--- a/docs/vi-VN/advanced-config/README.md
+++ b/docs/vi-VN/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`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ụ
@@ -280,5 +282,5 @@ Nếu nhiều màu được quy định cho màu chữ/màu nền, cái cuối c
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md
index ca3944107..49d5f6fab 100644
--- a/docs/vi-VN/config/README.md
+++ b/docs/vi-VN/config/README.md
@@ -15,15 +15,17 @@ Tất cả cấu hình của starship đã xong trong tập tin này: [TOML](htt
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
Bạn thay đổi địa chỉ tệp tin cấu hình mặc định bằng biến môi trường `STARSHIP_CONFIG`:
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
Bằng việc quy ước, đa số các module có một tiền tố của terminal mặc định (ví dụ `via` trong "nodejs") và một khoảng trắng như là một hậu tố.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+Ví dụ:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Định dạng các chuỗi
Định dạng các chuỗi là định dạng một module với việc in ra tất cả các biến của nó. Đa số các module có một cái bắt đầu gọi là `format`, cái đó cấu hình việc hiển thị định dạng của module. Bạn có thể sử dụng các văn bản, các biến và các nhóm văn bản trong một định dạng chuỗi.
@@ -80,9 +138,9 @@ Một biến chứa một kí hiệu `$` theo sau bởi tên biến. The name of
Ví dụ:
-- `$version` là một đính dạng chuỗi với một biến đặt tên là `version`.
-- `$git_branch$git_commit` là một định dạng chuỗi với hai biến named `git_branch` và `git_commit`.
-- `$git_branch $git_commit` có hai biến phân cách bằng một khoảng trắng.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Nhóm văn bản
@@ -94,20 +152,20 @@ Phần thứ hai, cái được bao bọc trong một `()`, là một [chuỗi k
Ví dụ:
-- `[on](red bold)` sẽ in một chuỗi `on` với chữ đậm tô màu đỏ.
-- `[⌘ $version](bold green)` sẽ in một biểu tượng `⌘` theo sau là nội dung của biến `version`, với chữ in đậm màu xanh lá cây.
-- `[a [b](red) c](green)` sẽ in `a b c` với `b` màu đỏ, `a` và `c` màu xanh lá cây.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Các chuỗi kiểu
Đa số các module trong starship cho phép bạn cấu hình kiểu hiển thị của chúng. This is done with an entry (thường được gọi là `kiểu`) cái là một cuỗi cấu hình đặc biệt. Đây là vài ví dụ của các chuỗi kiểu cũng với những gì chúng làm. Cú pháp chi tiết đầy đủ, tham khảo [hướng dẫn cấu hình nâng cao](/advanced-config/).
-- `"fg:green bg:blue"` thiết lập chữ màu xanh lá cây trên nền màu xanh nước biển
-- `"bg:blue fg:bright-green"` thiết lập chữ màu xanh lá cây sáng trên nền màu canh nước biển
-- `"bold fg:27"` thiết lập chữ đậm với [màu ANSI](https://i.stack.imgur.com/KTSQa.png) 27
-- `"underline bg:#bf5700"` thiết lập chữ gạch chân trên một nền màu da cam
-- `"bold italic fg:purple"` thiết lập chữa nghiêng đậm có màu tím
-- `""` vô hiệu hoá tất cả các kiểu
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
Lưu ý rằng những style trông như thế nào sẽ được điều khiển bởi giả lập terminal của bạn. Ví dụ, một vài giả lập terminal sẽ làm sáng những màu thay vì làm đậm chữ, và một vài theme màu sử dụng cũng các giá trị cho các màu thường và màu sáng. Tương tự, để có được chữ nghiêng, terminal của bạn phải hỗ trợ các kiểu chữ nghiêng.
@@ -117,43 +175,20 @@ Một điều kiện định dạng chuỗi bọc trong `(` và `)` sẽ không
Ví dụ:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(một vài văn bản)` sẽ không hiển thị thứ gì khi không có những biến bọc trong các dấu ngoặc.
-- Khi `$all` là một shortcut cho `\[$a$b\]`, `($all)` sẽ không hiển thị chỉ khi `$a` và `$b` đều là `None`. Cái này làm việc giống như `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-Ví dụ, khi bạn muốn in một kí hiệu `$` trên một dòng mới, các cấu hình sau cho `định dạng` tương đương:
-
-```toml
-# với chuỗi cơ bản
-format = "\n\\$"
-
-# với chuỗi cơ bản trong nhiều dòng
-format = """
-
-\\$"""
-
-# với chuỗi đặc biệt
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Prompt
@@ -165,11 +200,11 @@ Cái này là danh sách các tuỳ chọn cho cấu hình prompt-wide.
| Tuỳ chọn | Mặc định | Mô tả |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Cấu hình định dạng của prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout của starship cho việc quét các tập tin (tính theo milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Chèn dòng trắng giữa các dấu nhắc lệnh. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Ví dụ
@@ -177,27 +212,27 @@ Cái này là danh sách các tuỳ chọn cho cấu hình prompt-wide.
```toml
# ~/.config/starship.toml
-# Sử dụng định dạng custom
-format = """
+# Use custom format
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
-# Chờ 10 milliseconds để starship kiểm tra các tập tin trong đường dẫn hiện tại.
+# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Định dạng prompt mặc định
@@ -205,7 +240,7 @@ mustard = "#af8700"
Mặc định `format` được sử dụng để định nghĩa định dạng của prompt, nếu rỗng hoặc không `format` được cung cấp. Mặc định như sau:
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Định dạng cho module. |
-| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. |
-| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | Kiểu cho module. |
+| `symbol` | `'☁️ '` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. |
+| `region_aliases` | `{}` | Bảng của các region alias để hiển thị ngoài tên AWS. |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | Kiểu cho module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Vô hiệu `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -330,7 +371,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
*: Biến này có thể chỉ được sử dụng như một phần của style string
-### Các vị dụ
+### Các ví dụ
#### Hiển thị mọi thứ
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Hiển thị profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Các tuỳ chọn
| Biến | Mặc định | Mô tả |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### Ví dụ
+### Các ví dụ
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ style = "blue bold"
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | --------------------------------- | -------------------------------------------------------- |
-| `full_symbol` | `" "` | Kí hiệu cho biết khi pin đầy. |
-| `charging_symbol` | `" "` | Kí hiệu cho biết khi ping đang sạc. |
-| `discharging_symbol` | `" "` | Kí hiệu cho biết khi pin đang không sạc. |
-| `unknown_symbol` | `" "` | Kí hiệu cho biết khi trạng thái pin không được xác định. |
-| `empty_symbol` | `" "` | Kí hiệu cho biết khi hết pin. |
-| `format` | `"[$symbol$percentage]($style) "` | Định dạng cho module. |
+| `full_symbol` | `' '` | Kí hiệu cho biết khi pin đầy. |
+| `charging_symbol` | `' '` | Kí hiệu cho biết khi ping đang sạc. |
+| `discharging_symbol` | `' '` | Kí hiệu cho biết khi pin đang không sạc. |
+| `unknown_symbol` | `' '` | Kí hiệu cho biết khi trạng thái pin không được xác định. |
+| `empty_symbol` | `' '` | Kí hiệu cho biết khi hết pin. |
+| `format` | `'[$symbol$percentage]($style) '` | Định dạng cho module. |
| `display` | [link](#battery-display) | Ngưỡng hiển thị và kiểu cho module. |
| `disabled` | `false` | Vô hiệu `battery` module. |
@@ -423,9 +478,9 @@ style = "blue bold"
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Hiển thị pin
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ Tuỳ chọn `display` là một mảng của của bảng sau.
| Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | Cận trên cho tuỳ chọn hiển thị. |
-| `style` | `"red bold"` | Kiểu sử dụng nếu tuỳ chọn hiển thị được sử dụng bên trong. |
+| `style` | `'red bold'` | Kiểu sử dụng nếu tuỳ chọn hiển thị được sử dụng bên trong. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Ví dụ
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
-| `style` | `"bold blue"` | Kiểu cho module. |
+| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu mô đun `elixir`. |
### Các biến
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🍞 "` | A format string representing the symbol of Node.js. |
+| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
-| `style` | `"bold red"` | Kiểu cho module. |
+| `style` | `'bold red'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `bun` module. |
### Các biến
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | Kiểu cho module. |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `c` module. |
### Các biến
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ Mặc định, nó chỉ thay đổi màu. If you also want to change its shape
| Tuỳ chọn | Mặc định | Mô tả |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | Định dạng chuỗi sử dụng trước văn bản nhập vào. |
-| `success_symbol` | `"[❯](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thành công. |
-| `error_symbol` | `"[❯](bold red)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thất bại. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu shell trong chế độ vim normal. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | Định dạng chuỗi sử dụng trước văn bản nhập vào. |
+| `success_symbol` | `'[❯](bold green)'` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thành công. |
+| `error_symbol` | `'[❯](bold red)'` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thất bại. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu shell trong chế độ vim normal. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Vô hiệu module `character`. |
### Các biến
@@ -626,7 +681,7 @@ Mặc định, nó chỉ thay đổi màu. If you also want to change its shape
| ------ | ----- | -------------------------------------------------------------------------------------------------------- |
| symbol | | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. |
-### Các vị dụ
+### Các ví dụ
#### Có tuỳ chỉnh hình dạng lỗi
@@ -634,8 +689,8 @@ Mặc định, nó chỉ thay đổi màu. If you also want to change its shape
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Không có tuỳ chỉnh hình dạng lỗi
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### Có tuỳ chỉnh hình dạng vim
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,14 +723,14 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"△ "` | Kí hiệu sử dụng trước phiên bản của cmake. |
+| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'△ '` | Kí hiệu sử dụng trước phiên bản của cmake. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Tên tệp nào sẽ kích hoạt mô-đun này |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Tên tệp nào sẽ kích hoạt mô-đun này |
| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này |
-| `style` | `"bold blue"` | Kiểu cho module. |
-| `disabled` | `false` | Vô hiệu module `cmake`. |
+| `style` | `'bold blue'` | Kiểu cho module. |
+| `disabled` | `false` | Vô hiệu hoá `cmake` module. |
### Các biến
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | Kiểu cho module. |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | Kiểu cho module. |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ Người dùng Bash, những người cần chức năng giống preexec có th
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Khoảng thời gian ngắn nhất để hiện thời gian (tính bằng milliseconds). |
| `show_milliseconds` | `false` | Hiện milliseconds. |
-| `format` | `"took [$duration]($style) "` | Định dạng cho module. |
-| `style` | `"bold yellow"` | Kiểu cho module. |
+| `format` | `'took [$duration]($style) '` | Định dạng cho module. |
+| `style` | `'bold yellow'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu module `cmd_duration`. |
| `show_notifications` | `false` | Hiện thông báo desktop khi câu lệnh hoàn thành. |
| `min_time_to_notify` | `45_000` | Khoảng thời gian ngắn nhất để thông báo (tính bằng milliseconds). |
@@ -758,7 +813,7 @@ Người dùng Bash, những người cần chức năng giống preexec có th
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | Số lượng đường dẫn của biến môi trường nên được cắt bớt, nếu biến môi trường được tạo thông qua via `conda create -p [path]`. `0` nghĩa là không cắt bớt. Cũng thấy trong module [`directory`](#directory). |
-| `symbol` | `"🅒 "` | Kí hiệu sử dụng trước tên biến môi trường. |
-| `style` | `"bold green"` | Kiểu cho module. |
-| `format` | `"via [$symbol$environment]($style) "` | Định dạng cho module. |
+| `symbol` | `'🅒 '` | Kí hiệu sử dụng trước tên biến môi trường. |
+| `style` | `'bold green'` | Kiểu cho module. |
+| `format` | `'via [$symbol$environment]($style) '` | Định dạng cho module. |
| `ignore_base` | `true` | Bỏ qua biến môi trường `base` khi đã kích hoạt. |
| `disabled` | `false` | Vô hiệu module `conda`. |
@@ -798,7 +853,7 @@ Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | Kiểu cho module. |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | Kiểu cho module. |
| `format` | `'[$symbol \[$name\]]($style) '` | Định dạng cho module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | Kiểu cho module. |
-| `detect_extensions` | `["cr"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
-| `detect_files` | `["shard.yml"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
+| `symbol` | `'🔮 '` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | Kiểu cho module. |
+| `detect_extensions` | `['cr']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
+| `detect_files` | `['shard.yml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Vô hiệu hoá module `crystal`. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
-| `style` | `"bold cyan"` | Kiểu cho module. |
+| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
+| `style` | `'bold cyan'` | Kiểu cho module. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
-| `detect_files` | `["daml.yaml"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
+| `detect_files` | `['daml.yaml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🎯 "` | Một chuỗi định dạng hiển thị biểu tượng của Dart |
-| `detect_extensions` | `["dart"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
-| `detect_folders` | `[".dart_tool"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
-| `style` | `"bold blue"` | Kiểu cho module. |
+| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🎯 '` | Một chuỗi định dạng hiển thị biểu tượng của Dart |
+| `detect_extensions` | `['dart']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
+| `detect_folders` | `['.dart_tool']` | Những thư mục nào sẽ kích hoạt mô-đun này. |
+| `style` | `'bold blue'` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `dart` module. |
### Các biến
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
+| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
-| `style` | `"green bold"` | Kiểu cho module. |
+| `style` | `'green bold'` | Kiểu cho module. |
| `disabled` | `false` | Disables the `deno` module. |
### Các biến
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Đường dẫn
@@ -996,20 +1051,21 @@ Cho ví dụ, `~/Dev/Nix/nixpkgs/pkgs` nơi `nixpkgs` là gốc của repo, và
### Các tuỳ chọn
-| Tuỳ chọn | Mặc định | Mô tả |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | Số lượng thư mục cha của thư mục hiện tại nên được rút gọn. |
-| `truncate_to_repo` | `true` | Có hoặc không rút gọn đường dẫn gốc của git repo hiện tại của bạn. |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Định dạng cho module. |
-| `style` | `"bold cyan"` | Kiểu cho module. |
-| `disabled` | `false` | Vô hiệu mô đun `directory`. |
-| `read_only` | `"🔒"` | Biểu tượng để nhận biết thư mục hiện tại là chỉ đọc. |
-| `read_only_style` | `"red"` | Style cho biểu tượng chỉ đọc. |
-| `truncation_symbol` | `""` | Biểu tượng tiền tố cho các đường dẫn rút gọn. ví dụ: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | Biểu tượng nhận biết thư mục home. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Tuỳ chọn | Mặc định | Mô tả |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | Số lượng thư mục cha của thư mục hiện tại nên được rút gọn. |
+| `truncate_to_repo` | `true` | Có hoặc không rút gọn đường dẫn gốc của git repo hiện tại của bạn. |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | Định dạng cho module. |
+| `style` | `'bold cyan'` | Kiểu cho module. |
+| `disabled` | `false` | Vô hiệu mô đun `directory`. |
+| `read_only` | `'🔒'` | Biểu tượng để nhận biết thư mục hiện tại là chỉ đọc. |
+| `read_only_style` | `'red'` | Style cho biểu tượng chỉ đọc. |
+| `truncation_symbol` | `''` | Biểu tượng tiền tố cho các đường dẫn rút gọn. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | Biểu tượng nhận biết thư mục home. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
Mô đun này có một vài tùy chọn nâng cao để điều khiển cách thư mục được hiển thị.
@@ -1024,8 +1080,8 @@ Cho ví dụ, `~/Dev/Nix/nixpkgs/pkgs` nơi `nixpkgs` là gốc của repo, và
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ Cho ví dụ, `~/Dev/Nix/nixpkgs/pkgs` nơi `nixpkgs` là gốc của repo, và
| Biến | Ví dụ | Mô tả |
| --------- | --------------------- | -------------------------- |
-| path | `"D:/Projects"` | Đường dẫn thư mục hiện tại |
-| style\* | `"black bold dimmed"` | Giá trị ghi đè của `style` |
+| path | `'D:/Projects'` | Đường dẫn thư mục hiện tại |
+| style\* | `'black bold dimmed'` | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| Biến | Ví dụ | Mô tả |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Giá trị ghi đè của `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Giá trị ghi đè của `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -417,6 +416,14 @@ Xin hãy xem qua những công việc này trước đây, những thứ đã gi
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
+## ❤️ Sponsors
+
+Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
+
+**Supporter Tier**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/vi-VN/presets/README.md b/docs/vi-VN/presets/README.md
index 7b37c28b7..8f8267580 100644
--- a/docs/vi-VN/presets/README.md
+++ b/docs/vi-VN/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
@@ -28,6 +36,12 @@ This preset hides the version of language runtimes. If you work in containers or
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/vi-VN/presets/no-empty-icons.md b/docs/vi-VN/presets/no-empty-icons.md
new file mode 100644
index 000000000..86bcab854
--- /dev/null
+++ b/docs/vi-VN/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### Cấu hình
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/vi-VN/presets/no-nerd-font.md b/docs/vi-VN/presets/no-nerd-font.md
new file mode 100644
index 000000000..d439af0a1
--- /dev/null
+++ b/docs/vi-VN/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### Cấu hình
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/vi-VN/presets/tokyo-night.md b/docs/vi-VN/presets/tokyo-night.md
new file mode 100644
index 000000000..c608f2efe
--- /dev/null
+++ b/docs/vi-VN/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### Yêu cầu
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
+
+### Cấu hình
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md
index 0ddd1e58b..e3d658fa0 100644
--- a/docs/zh-CN/README.md
+++ b/docs/zh-CN/README.md
@@ -66,7 +66,7 @@ description: Starship是一款轻量级、反应迅速、可自定义的高颜
#### Bash
- 在 `~/.bashhrc` 的最后，添加以下内容：
+ 在 `~/.bashrc` 的最后，添加以下内容：
```sh
# ~/.bashrc
@@ -97,7 +97,7 @@ description: Starship是一款轻量级、反应迅速、可自定义的高颜
```
- #### Powershell
+ #### Power Shell
将以下内容添加到 `Microsoft.PowerShell_profile.ps1`。 你可以在 PowerShell 通过 `$PROFILE` 变量来查询文件的位置。 对于 -Nix 来说，通常文件路径是 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 或 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`。
@@ -136,7 +136,7 @@ description: Starship是一款轻量级、反应迅速、可自定义的高颜
#### Tcsh
- 在 `~/.bashhrc` 的最后，添加以下内容：
+ 在 `~/.tcshrc` 的最后，添加以下内容：
```sh
# ~/.tcshrc
@@ -167,7 +167,7 @@ description: Starship是一款轻量级、反应迅速、可自定义的高颜
#### Xonsh
- 在 `~/.bashhrc` 的最后，添加以下内容：
+ 在 `~/.xonshrc` 的最后，添加以下内容：
```sh
# ~/.xonshrc
diff --git a/docs/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md
index 1ed5b3b55..d4e3e2273 100644
--- a/docs/zh-CN/advanced-config/README.md
+++ b/docs/zh-CN/advanced-config/README.md
@@ -205,7 +205,9 @@ Invoke-Expression (&starship init powershell)
注意：右侧提示和输入区显示在同一行。 如果需要在输入区的上方显示右对齐的组件，请查阅 [`fill` 组件](/config/#fill)。
-`right_format` 现支持 elvish、fish、zsh、xonsh、cmd。
+`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
+
+Note: Nushell 0.71.0 or later is required
### 示例
@@ -280,5 +282,5 @@ continuation_prompt = "▶▶"
并非每种类型的字符串都会被每个终端正确显示。 特别地，以下是已知的几种情况：
- 许多终端默认禁用对 `blink` 的支持
-- `hidden` 在 iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564) 上不被支持。
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` 不被默认 macOS Terminal.app 支持
diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md
index 8a70ea13f..053c003fc 100644
--- a/docs/zh-CN/config/README.md
+++ b/docs/zh-CN/config/README.md
@@ -9,21 +9,23 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Starship 的所有配置都在此 [TOML](https://github.com/toml-lang/toml) 配置文件中完成：
```toml
-# 设置配置范例，开启编辑器的自动补全
+# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'
-# 在命令之间插入空行
+# Inserts a blank line between shell prompts
add_newline = true
-# 将提示符的“❯”替换为“➜”
-[character] # “character”是我们正在配置的组件
-success_symbol = "[➜](bold green)" # 设置“success_symbol” 字段为绿色加粗的“➜”
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
-# 禁用 package 组件，完全隐藏它的提示符
+# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
您可以使用 `STARSHIP_CONFIG` 环境变量更改默认配置文件的位置：
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
依惯例，大多组件都有一个带有默认终端颜色的前缀（例如“nodejs”的 `via`），以及一个空格作为后缀。
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+例如：
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### 格式设定
组件会根据定义的格式输出它所有的字段。 大多数组件可以通过 `format` 项来配置它的显示格式。 格式设定内可以包含文本、字段以及文本组。
@@ -80,9 +138,9 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
例如：
-- 格式设定 `$version` 由一个变量 `version` 组成。
-- 格式设定 `$git_branch$git_commit` 由两个变量 `git_branch`、`git_commit` 组成。
-- 格式设定 `$git_branch $git_commit` 由两个变量和一个空格组成。
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### 文本组
@@ -94,20 +152,20 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
例如：
-- `[on](red bold)` 会输出一个加粗的红色 `on`。
-- `[⌘ $version](bold green)` 会先输出一个 `⌘`，之后是 `version` 字段的内容，都是绿色加粗的样式。
-- `[a [b](red) c](green)` 会依序输出绿色 `a`、红色 `b`、绿色 `c`。
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### 样式设定
Starship 中的大多数组件允许您为其设置显示样式。 显示样式可以通过一个字符串字段（一般是 `style`）来设置。 以下的例子给出了一些样式字符串并描述了它们的效果。 样式字符串的完整语法请查阅 [高级配置指南](/advanced-config/)。
-- `"fg:green bg:blue"` 在蓝色背景上显示绿色文本
-- `"bg:blue fg:bright-green"` 在蓝色背景上显示亮绿色文本
-- `"bold fg:27"` 设置粗体字，用 27 号 [ANSI 标准色](https://i.stack.imgur.com/KTSQa.png)
-- `"underline bg:#bf5700"` 在深橙色背景上显示带下划线文本
-- `"bold italic fg:purple"` 设置文本为粗体、意大利体，颜色为紫色
-- `""` 显式禁用所有样式
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
请注意，最终的显示样式将由您的终端模拟器控制。 例如，有的终端模拟器对于“bold”属性的文本是加亮颜色而不是加粗文字，有的颜色主题对“普通”和“明亮”两种属性的颜色使用相同的颜色值。 此外，要获得意大利体文本（一般设计为斜体），您的终端必须支持意大利体显示。
@@ -117,43 +175,20 @@ Starship 中的大多数组件允许您为其设置显示样式。 显示样式
例如：
-- 如果变量 `region` 是 `None` 或者为空，`(@$region)` 将不会显示，否则 `@` 之后会显示 region 的值。
-- `(some text)` 将永远不会显示因为在括号里并没有变量。
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### 特殊字符
-
-以下符号在格式字符串中具有特殊用途，必须转义： `$ [ ] ( )`。
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). 建议在你的配置中使用字面字符串(由单引号包围)。 如果你想使用一个基本的字符串(由双引号包围)，你必须在双引号前面添加反斜杠符号进行转义（即使用\“abc\"输出"abc"）。
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### 错误匹配
-许多模块都有 detect_extensions, detect_files, 和 detect_folders 变量。 These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+许多模块都有 detect_extensions, detect_files, 和 detect_folders 变量。 These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## 提示符
@@ -165,11 +200,11 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
| 选项 | 默认值 | 描述 |
| ----------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [见下文](#default-prompt-format) | 配置提示符的格式。 |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Starship 扫描文件的超时时间（单位：毫秒）。 |
| `command_timeout` | `500` | Startship 执行命令的超时时间（单位：毫秒）。 |
| `add_newline` | `true` | 在 shell 提示符之间插入空行。 |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### 示例
@@ -178,10 +213,10 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,23 +224,23 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### 默认提示符格式
-如果没有提供`format`字段或者它的值是空的，将会使用默认的`format`配置来指定提示符的格式。 默认设置如下：
+如果没有提供`format`字段或者它的值是空的，将会使用默认的`format`配置来指定提示符的格式。 默认配置如下：
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -289,8 +328,8 @@ $character"""
如果你只是想扩展默认的格式，你可以使用 `$all`; 你另外添加到格式中的modules不会重复出现。 例如：
```toml
-# 将目录信息移到第二行
-format = "$all$directory$character"
+# Move the directory to the second line
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### 配置项
| 选项 | 默认值 | 描述 |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | 组件格式化模板。 |
-| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 |
-| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | 此组件的样式。 |
+| `symbol` | `'☁️ '` | 这个字段的内容会显示在当前 AWS 配置信息之前。 |
+| `region_aliases` | `{}` | 地区缩写列表，用来显示在 AWS 主机名之后。 |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | 此组件的样式。 |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | 禁用 `AWS` 组件。 |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### 配置项
| 字段 | 默认值 | 描述 |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### 示例
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ style = "blue bold"
| 选项 | 默认值 | 描述 |
| -------------------- | --------------------------------- | ---------------- |
-| `full_symbol` | `" "` | 显示于电池充满时。 |
-| `charging_symbol` | `" "` | 显示于正在充电时。 |
-| `discharging_symbol` | `" "` | 显示于电池放电时。 |
-| `unknown_symbol` | `" "` | 显示于电池状态未知时 |
-| `empty_symbol` | `" "` | 显示于电池状态为空时 |
-| `format` | `"[$symbol$percentage]($style) "` | 组件格式化模板。 |
+| `full_symbol` | `' '` | 显示于电池充满时。 |
+| `charging_symbol` | `' '` | 显示于正在充电时。 |
+| `discharging_symbol` | `' '` | 显示于电池放电时。 |
+| `unknown_symbol` | `' '` | 显示于电池状态未知时 |
+| `empty_symbol` | `' '` | 显示于电池状态为空时 |
+| `format` | `'[$symbol$percentage]($style) '` | 组件格式化模板。 |
| `display` | [见下文](#battery-display) | 电量显示阈值和样式。 |
| `disabled` | `false` | 禁用 `battery` 组件。 |
@@ -423,19 +478,19 @@ style = "blue bold"
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### Battery 组件的显示
-The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). 如果 `display` 没有设置， 默认设置如下：
+The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). 如果 `display` 没有设置， 默认配置如下：
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r
| 选项 | 默认值 | 描述 |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | 当前显示设置的电量上限（见示例） |
-| `style` | `"red bold"` | 若组件被显示，则使用此样式 |
+| `style` | `'red bold'` | 若组件被显示，则使用此样式 |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### 示例
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| 选项 | 默认值 | 描述 |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | 此组件的样式。 |
+| `style` | `'bold blue'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | 此组件的样式。 |
+| `style` | `'bold red'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| 选项 | 默认值 | 描述 |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | 此组件的样式。 |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## Character
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| 选项 | 默认值 | 描述 |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | 禁用 `character` 组件。 |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"△ "` | The symbol used before the version of cmake. |
+| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'△ '` | The symbol used before the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | 此组件的样式。 |
+| `style` | `'bold blue'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | 此组件的样式。 |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | 此组件的样式。 |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | 显示此组件所需的最短执行时长（单位：毫秒）。 |
| `show_milliseconds` | `false` | 除了秒数外在执行时长中额外显示毫秒。 |
-| `format` | `"took [$duration]($style) "` | 组件格式化模板。 |
-| `style` | `"bold yellow"` | 此组件的样式。 |
+| `format` | `'took [$duration]($style) '` | 组件格式化模板。 |
+| `style` | `'bold yellow'` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `cmd_duration` 组件。 |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e
| 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | 如果这个 conda 环境是通过 `conda create -p [path]` 创建的，环境路径的目录深度应该被截断到此数量。 `0` 表示不用截断。 另请参阅 [`directory`](#directory) 组件。 |
-| `symbol` | `"🅒 "` | 在环境名之前显示的符号。 |
-| `style` | `"bold green"` | 此组件的样式。 |
-| `format` | `"via [$symbol$environment]($style) "` | 组件格式化模板。 |
+| `symbol` | `'🅒 '` | 在环境名之前显示的符号。 |
+| `style` | `'bold green'` | 此组件的样式。 |
+| `format` | `'via [$symbol$environment]($style) '` | 组件格式化模板。 |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | 禁用 `conda` 组件。 |
@@ -798,7 +853,7 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| 选项 | 默认值 | 描述 |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | 此组件的样式。 |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | 此组件的样式。 |
| `format` | `'[$symbol \[$name\]]($style) '` | 组件格式化模板。 |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | 此组件的样式。 |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | 此组件的样式。 |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `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 Daml |
-| `style` | `"bold cyan"` | 此组件的样式。 |
+| `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 Daml |
+| `style` | `'bold cyan'` | 此组件的样式。 |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
-| `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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | 此组件的样式。 |
+| `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 Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 选项 | 默认值 | 描述 |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | 此组件的样式。 |
+| `style` | `'green bold'` | 此组件的样式。 |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## Directory
@@ -996,20 +1051,21 @@ format = "via [🦕 $version](green bold) "
### 配置项
-| 选项 | 默认值 | 描述 |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | 当前目录路径被截断后最多保留的父目录数量。 |
-| `truncate_to_repo` | `true` | 是否只截断到您当前处于的 git 仓库根目录下。 |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | 组件格式化模板。 |
-| `style` | `"bold cyan"` | 此组件的样式。 |
-| `disabled` | `false` | 禁用 `directory` 组件。 |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| 选项 | 默认值 | 描述 |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | 当前目录路径被截断后最多保留的父目录数量。 |
+| `truncate_to_repo` | `true` | 是否只截断到您当前处于的 git 仓库根目录下。 |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | 组件格式化模板。 |
+| `style` | `'bold cyan'` | 此组件的样式。 |
+| `disabled` | `false` | 禁用 `directory` 组件。 |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
此组件有几个高级配置选项来控制当前目录路径的显示方式。
@@ -1024,8 +1080,8 @@ format = "via [🦕 $version](green bold) "
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ format = "via [🦕 $version](green bold) "
| 字段 | 示例 | 描述 |
| --------- | --------------------- | -------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | `style`对应值 |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | `style`对应值 |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| 字段 | 示例 | 描述 |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | `style`对应值 |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | `style`对应值 |
+| repo_root_style | `'underline white'` | Style for git root directory name |
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -271,7 +270,7 @@ curl -sS https://starship.rs/install.sh | sh
Bash
-在 `~/.bashhrc` 的最后，添加以下内容：
+在 `~/.bashrc` 的最后，添加以下内容：
```sh
eval "$(starship init bash)"
@@ -359,7 +358,7 @@ Invoke-Expression (&starship init powershell)
Tcsh
-在 `~/.bashhrc` 的最后，添加以下内容：
+在 `~/.tcshrc` 的最后，添加以下内容：
```sh
eval `starship init tcsh`
@@ -370,7 +369,7 @@ eval `starship init tcsh`
Xonsh
-在 `~/.bashhrc` 的最后，添加以下内容：
+在 `~/.xonshrc` 的最后，添加以下内容：
```python
execx($(starship init xonsh))
@@ -417,6 +416,14 @@ eval "$(starship init zsh)"
- **[reujab/silver](https://github.com/reujab/silver)** – 带图标且可定制的类 Powerline 提示符，适用于所有 Shell。
+## ❤️ 赞助商
+
+通过 [成为赞助商 ](https://github.com/sponsors/starship)来支持这个项目。 您的名字或 LOGO 将在此处显示，并链接到您的网站。
+
+**支持者级别**
+
+- [Dimension](https://dimension.dev/)
+
diff --git a/docs/zh-CN/presets/README.md b/docs/zh-CN/presets/README.md
index a0ab838fa..f479c6155 100644
--- a/docs/zh-CN/presets/README.md
+++ b/docs/zh-CN/presets/README.md
@@ -10,6 +10,14 @@
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [Bracketed Segments](./bracketed-segments.md)
此预设使用括号来分隔所有组件的提示符，不使用 Starship 默认的分隔词（“via”，“on” 等等）。
@@ -28,6 +36,12 @@
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
此预设模拟 [Pure](https://github.com/sindresorhus/pure) 的外观和行为。
@@ -39,3 +53,9 @@
此预设的灵感来自于 [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json)。 它同时也演示了 Starship 的路径替换功能。
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/zh-CN/presets/no-empty-icons.md b/docs/zh-CN/presets/no-empty-icons.md
new file mode 100644
index 000000000..1360d8ec3
--- /dev/null
+++ b/docs/zh-CN/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[返回全部预设](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### 配置
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[点击下载 TOML 文件](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/zh-CN/presets/no-nerd-font.md b/docs/zh-CN/presets/no-nerd-font.md
new file mode 100644
index 000000000..6469044c4
--- /dev/null
+++ b/docs/zh-CN/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[返回全部预设](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### 配置
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[点击下载 TOML 文件](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/zh-CN/presets/tokyo-night.md b/docs/zh-CN/presets/tokyo-night.md
new file mode 100644
index 000000000..60d9a0e5a
--- /dev/null
+++ b/docs/zh-CN/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[返回全部预设](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### 前置要求
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
+
+### 配置
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[点击下载 TOML 文件](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md
index e93fb9974..e93d3cdbc 100644
--- a/docs/zh-TW/README.md
+++ b/docs/zh-TW/README.md
@@ -7,7 +7,7 @@ actionText: 馬上開始 →
actionLink: ./guide/
features:
-
- title: 兼容性優先
+ title: 相容性優先
details: 能夠在最常見的作業系統之中最常見的 shell 上運作。 在各處使用它吧！
-
title: 以 Rust 開發
@@ -176,7 +176,7 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化
```
- #### 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:
diff --git a/docs/zh-TW/advanced-config/README.md b/docs/zh-TW/advanced-config/README.md
index f0a5ac7e8..05a5913aa 100644
--- a/docs/zh-TW/advanced-config/README.md
+++ b/docs/zh-TW/advanced-config/README.md
@@ -205,7 +205,9 @@ Some shells support a right prompt which renders on the same line as the input.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
-`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.
+`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell.
+
+Note: Nushell 0.71.0 or later is required
### 範例
@@ -280,5 +282,5 @@ The `none` token overrides all other tokens in a string if it is not part of a `
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for `blink` by default
-- `hidden` is not supported on iTerm (https://gitlab.com/gnachman/iterm2/-/issues/4564).
+- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
- `strikethrough` is not supported by the default macOS Terminal.app
diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md
index 36496fadf..9ab3f544b 100644
--- a/docs/zh-TW/config/README.md
+++ b/docs/zh-TW/config/README.md
@@ -15,15 +15,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
# Inserts a blank line between shell prompts
add_newline = true
-# Replace the "❯" symbol in the prompt with "➜"
-[character] # The name of the module we are configuring is "character"
-success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green"
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
+### Config File Location
+
你可以透過更改環境變數 `STARSHIP_CONFIG` 來變更設定檔存放的位置：
```sh
@@ -70,6 +72,62 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
+### Strings
+
+In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
+
+The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
+
+| Symbol | Type | Notes |
+| ------ | ------------------------- | ------------------------------------------------------ |
+| `'` | literal string | less escaping |
+| `"` | string | more escaping |
+| `'''` | multi-line literal string | less escaping |
+| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
+
+For example:
+
+```toml
+# literal string
+format = '☺\☻ '
+
+# regular string
+format = "☺\\☻ "
+
+# escaping Starship symbols
+format = '\[\$\] '
+```
+
+When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
+
+```toml
+# with literal string
+format = '''
+
+\$'''
+
+# with multiline basic string
+format = """
+
+\\$"""
+
+# with basic string
+format = "\n\\$"
+```
+
+In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
+
+```toml
+format = """
+line1\
+line1\
+line1
+line2\
+line2\
+line2
+"""
+```
+
### Format Strings
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.
@@ -80,9 +138,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
For example:
-- `$version` is a format string with a variable named `version`.
-- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
-- `$git_branch $git_commit` has the two variables separated with a space.
+- `'$version'` is a format string with a variable named `version`.
+- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
+- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Text Group
@@ -94,20 +152,20 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
For example:
-- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
-- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
+- `'[on](red bold)'` will print a string `on` with bold text colored red.
+- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
+- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### 風格字串
Starship 內大多數的模組允許你設定他們的顯示風格。 這要透過一個條目 (通常叫做 `style`)，這個條目使用一個字串來進行設定。 這裡給幾個風格字串的例子，以及這些字串的功用。 對於完整語法的詳細說明，請參照 [進階設定指南](/advanced-config/)。
-- `"fg:green bg:blue"` 在一個藍色背景上設定綠色文字
-- `"bg:blue fg:bright-green"` 在一個藍色背景上設定亮綠色文字
-- `"bold fg:27"` 設定具有 [ANSI 顏色](https://i.stack.imgur.com/KTSQa.png) 27 號的粗體文字
-- `"underline bg:#bf5700"` 在一個燒橙色背景上設定有底線的文字
-- `"bold italic fg:purple"` 設定粗體、斜體且紫色的文字
-- `""` 明確地關閉所有風格
+- `'fg:green bg:blue'` sets green text on a blue background
+- `'bg:blue fg:bright-green'` sets bright green text on a blue background
+- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
+- `'bold italic fg:purple'` sets bold italic purple text
+- `''` explicitly disables all styling
注意風格產出的樣子取決於你的終端機模擬器。 例如，有些終端機模擬器會提升顏色的亮度而不是讓文字變粗體，而且有些色彩主題對一般與加亮顏色使用的是相同色碼。 除此之外，為了要有斜體字，你的終端機一定要支援斜體。
@@ -117,43 +175,20 @@ A conditional format string wrapped in `(` and `)` will not render if all variab
For example:
-- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
-- `(some text)` will always show nothing since there are no variables wrapped in the braces.
-- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
-
-#### Special characters
-
-The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`.
-
-Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
-
-For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
-
-```toml
-# with basic string
-format = "\n\\$"
-
-# with multiline basic string
-format = """
-
-\\$"""
-
-# with literal string
-format = '''
-
-\$'''
-```
+- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
+- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
+- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
-Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading "!" character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
+Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
-detect_extensions = ["ts", "!video.ts", "!audio.ts"]
+detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## 提示字元
@@ -165,11 +200,11 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
| Option | 預設 | 說明 |
| ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [連結](#default-prompt-format) | Configure the format of the prompt. |
-| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
-| `palette` | `""` | Sets which color palette from `palettes` to use. |
+| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### 範例
@@ -178,10 +213,10 @@ detect_extensions = ["ts", "!video.ts", "!audio.ts"]
# ~/.config/starship.toml
# Use custom format
-format = """
+format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
-[└─>](bold green) """
+[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
@@ -189,15 +224,15 @@ scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
-# Set "foo" as custom color palette
-palette = "foo"
+# Set 'foo' as custom color palette
+palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
-blue = "21"
+blue = '21'
# Define new color
-mustard = "#af8700"
+mustard = '#af8700'
```
### Default Prompt Format
@@ -205,7 +240,7 @@ mustard = "#af8700"
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. 預設如下：
```toml
-format = "$all"
+format = '$all'
# Which is equivalent to
format = """
@@ -236,7 +271,9 @@ $elixir\
$elm\
$erlang\
$golang\
+$guix_shell\
$haskell\
+$haxe\
$helm\
$java\
$julia\
@@ -245,6 +282,7 @@ $lua\
$nim\
$nodejs\
$ocaml\
+$opa\
$perl\
$php\
$pulumi\
@@ -281,6 +319,7 @@ $jobs\
$battery\
$time\
$status\
+$os\
$container\
$shell\
$character"""
@@ -290,7 +329,7 @@ If you just want to extend the default format, you can use `$all`; modules you e
```toml
# Move the directory to the second line
-format = "$all$directory$character"
+format = '$all$directory$character'
```
## AWS
@@ -305,15 +344,17 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
+When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
+
### 選項
| Option | 預設 | 說明 |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
-| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 |
-| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 |
-| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
-| `style` | `"bold yellow"` | 這個模組的風格。 |
+| `symbol` | `'☁️ '` | 顯示在目前 AWS 配置之前的符號。 |
+| `region_aliases` | `{}` | 除了AWS名稱外，顯示區域別名表 |
+| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
+| `style` | `'bold yellow'` | 這個模組的風格。 |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | 停用 `AWS` 模組。 |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
@@ -339,11 +380,11 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
-style = "bold blue"
-symbol = "🅰 "
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
@@ -354,12 +395,12 @@ CompanyGroupFrobozzOnCallAccess = 'Frobozz'
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$region]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$region]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.region_aliases]
-ap-southeast-2 = "au"
-us-east-1 = "va"
+ap-southeast-2 = 'au'
+us-east-1 = 'va'
```
#### Display profile
@@ -368,34 +409,48 @@ us-east-1 = "va"
# ~/.config/starship.toml
[aws]
-format = "on [$symbol$profile]($style) "
-style = "bold blue"
-symbol = "🅰 "
+format = 'on [$symbol$profile]($style) '
+style = 'bold blue'
+symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
-The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
+The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### 選項
| 變數 | 預設 | 說明 |
| ---------- | ---------------------------------------- | ------------------------------------------ |
-| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
-| `symbol` | `"ﴃ "` | The symbol used in the format. |
-| `style` | `"blue bold"` | The style used in the format. |
+| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
+| `symbol` | `'ﴃ '` | The symbol used in the format. |
+| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
-### 範例
+### Examples
+
+#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
-format = "on [$symbol($subscription)]($style) "
+format = 'on [$symbol($subscription)]($style) '
+symbol = 'ﴃ '
+style = 'blue bold'
+```
+
+#### Display Username
+
+```toml
+# ~/.config/starship.toml
+
+[azure]
+disabled = false
+format = "on [$symbol($username)]($style) "
symbol = "ﴃ "
style = "blue bold"
```
@@ -408,12 +463,12 @@ style = "blue bold"
| Option | 預設 | 說明 |
| -------------------- | --------------------------------- | -------------------------- |
-| `full_symbol` | `" "` | 當電池充飽時顯示的符號。 |
-| `charging_symbol` | `" "` | 當電池正在充電時顯示的符號。 |
-| `discharging_symbol` | `" "` | 當電池正在放電時顯示的符號。 |
-| `unknown_symbol` | `" "` | 當電池狀態不明時顯示的符號。 |
-| `empty_symbol` | `" "` | 當電池沒電時顯示的符號。 |
-| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
+| `full_symbol` | `' '` | 當電池充飽時顯示的符號。 |
+| `charging_symbol` | `' '` | 當電池正在充電時顯示的符號。 |
+| `discharging_symbol` | `' '` | 當電池正在放電時顯示的符號。 |
+| `unknown_symbol` | `' '` | 當電池狀態不明時顯示的符號。 |
+| `empty_symbol` | `' '` | 當電池沒電時顯示的符號。 |
+| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
| `display` | [連結](#battery-display) | 顯示的門檻與模組的風格。 |
| `disabled` | `false` | 停用 `battery` 模組。 |
@@ -423,9 +478,9 @@ style = "blue bold"
# ~/.config/starship.toml
[battery]
-full_symbol = "🔋 "
-charging_symbol = "⚡️ "
-discharging_symbol = "💀 "
+full_symbol = '🔋 '
+charging_symbol = '⚡️ '
+discharging_symbol = '💀 '
```
### 電池顯示
@@ -435,7 +490,7 @@ The `display` configuration option is used to define when the battery indicator
```toml
[[battery.display]]
threshold = 10
-style = "bold red"
+style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
@@ -447,21 +502,21 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r
| Option | 預設 | 說明 |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | 顯示選項的上界。 |
-| `style` | `"red bold"` | 顯示選項使用時的風格。 |
+| `style` | `'red bold'` | 顯示選項使用時的風格。 |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### 範例
```toml
-[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
+[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
-style = "bold red"
+style = 'bold red'
-[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
+[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
-style = "bold yellow"
-discharging_symbol = "💦"
+style = 'bold yellow'
+discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
@@ -477,13 +532,13 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| Option | 預設 | 說明 |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
-| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
-| `version_format` | `"v${raw}"` | The version format. |
-| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
+| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
+| `version_format` | `'v${raw}'` | The version format. |
+| `symbol` | `'🦬 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | 這個模組的風格。 |
+| `style` | `'bold blue'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -502,7 +557,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
# ~/.config/starship.toml
[buf]
-symbol = "🦬 "
+symbol = '🦬 '
```
## Bun
@@ -516,13 +571,13 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
| 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 Node.js. |
+| `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 Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["bun.lockb", "bunfig.toml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"bold red"` | 這個模組的風格。 |
+| `style` | `'bold red'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `bun` module. |
### Variables
@@ -541,7 +596,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
# ~/.config/starship.toml
[bun]
-format = "via [🍔 $version](bold green) "
+format = 'via [🍔 $version](bold green) '
```
## C
@@ -552,14 +607,14 @@ The `c` module shows some information about your C compiler. By default the modu
| Option | 預設 | 說明 |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `symbol` | `"C "` | The symbol used before displaying the compiler details |
-| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. |
+| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `'C '` | The symbol used before displaying the compiler details |
+| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
-| `style` | `"bold 149"` | 這個模組的風格。 |
+| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
+| `style` | `'bold 149'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `c` module. |
### Variables
@@ -577,7 +632,7 @@ NB that `version` is not in the default format.
The `commands` option accepts a list of commands to determine the compiler version and name.
-Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT.
+Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
@@ -587,7 +642,7 @@ If a C compiler is not supported by this module, you can request it by [raising
# ~/.config/starship.toml
[c]
-format = "via [$name $version]($style)"
+format = 'via [$name $version]($style)'
```
## 字元
@@ -611,13 +666,13 @@ By default it only changes color. If you also want to change its shape take a lo
| Option | 預設 | 說明 |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
-| `format` | `"$symbol "` | The format string used before the text input. |
-| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
-| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. |
-| `vimcmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
-| `vimcmd_replace_one_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
-| `vimcmd_replace_symbol` | `"[❮](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
-| `vimcmd_visual_symbol` | `"[❮](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
+| `format` | `'$symbol '` | The format string used before the text input. |
+| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
+| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
+| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
+| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
+| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
+| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | 停用 `character` 模組。 |
### Variables
@@ -634,8 +689,8 @@ By default it only changes color. If you also want to change its shape take a lo
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[✗](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[✗](bold red) '
```
#### Without custom error shape
@@ -644,8 +699,8 @@ error_symbol = "[✗](bold red) "
# ~/.config/starship.toml
[character]
-success_symbol = "[➜](bold green) "
-error_symbol = "[➜](bold red) "
+success_symbol = '[➜](bold green) '
+error_symbol = '[➜](bold red) '
```
#### With custom vim shape
@@ -654,7 +709,7 @@ error_symbol = "[➜](bold red) "
# ~/.config/starship.toml
[character]
-vicmd_symbol = "[V](bold green) "
+vicmd_symbol = '[V](bold green) '
```
## CMake
@@ -668,13 +723,13 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| 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 the version of cmake. |
+| `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 the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | 這個模組的風格。 |
+| `style` | `'bold blue'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -698,11 +753,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| Option | 預設 | 說明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold blue"` | 這個模組的風格。 |
-| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold blue'` | 這個模組的風格。 |
+| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
@@ -735,8 +790,8 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | 這個模組的風格。 |
+| `format` | `'took [$duration]($style) '` | The format for the module. |
+| `style` | `'bold yellow'` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `cmd_duration` 模組。 |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@@ -758,7 +813,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
[cmd_duration]
min_time = 500
-format = "underwent [$duration](bold yellow)"
+format = 'underwent [$duration](bold yellow)'
```
## Conda
@@ -776,9 +831,9 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| Option | 預設 | 說明 |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | 如果環境變數由所`conda create -p [path]`產生時，環境變數的資料夾需要截斷的數目。 `0` 表示不截斷 也請參考 [`directory`](#directory)模組 |
-| `symbol` | `"🅒 "` | 環境名稱前使用的符號。 |
-| `style` | `"bold green"` | 這個模組的風格。 |
-| `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
+| `symbol` | `'🅒 '` | 環境名稱前使用的符號。 |
+| `style` | `'bold green'` | 這個模組的風格。 |
+| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | 停用 `conda` 模組。 |
@@ -798,7 +853,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
# ~/.config/starship.toml
[conda]
-format = "[$symbol$environment](dimmed green) "
+format = '[$symbol$environment](dimmed green) '
```
## Container
@@ -809,8 +864,8 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | 預設 | 說明 |
| ---------- | ---------------------------------- | ----------------------------------------- |
-| `symbol` | `"⬢"` | The symbol shown, when inside a container |
-| `style` | `"bold red dimmed"` | 這個模組的風格。 |
+| `symbol` | `'⬢'` | The symbol shown, when inside a container |
+| `style` | `'bold red dimmed'` | 這個模組的風格。 |
| `format` | `'[$symbol \[$name\]]($style) '` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. |
@@ -844,12 +899,12 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| Option | 預設 | 說明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
-| `style` | `"bold red"` | 這個模組的風格。 |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |
+| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
+| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `'bold red'` | 這個模組的風格。 |
+| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
+| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. |
@@ -869,7 +924,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
# ~/.config/starship.toml
[crystal]
-format = "via [✨ $version](bold blue) "
+format = 'via [✨ $version](bold blue) '
```
## Daml
@@ -882,12 +937,12 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| 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 Daml |
-| `style` | `"bold cyan"` | 這個模組的風格。 |
+| `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 Daml |
+| `style` | `'bold cyan'` | 這個模組的風格。 |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
+| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
@@ -907,7 +962,7 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
# ~/.config/starship.toml
[daml]
-format = "via [D $version](bold bright-green) "
+format = 'via [D $version](bold bright-green) '
```
## Dart
@@ -922,13 +977,13 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| 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 Dart |
-| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | 這個模組的風格。 |
+| `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 Dart |
+| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
+| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
+| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
+| `style` | `'bold blue'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -947,7 +1002,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
# ~/.config/starship.toml
[dart]
-format = "via [🔰 $version](bold red) "
+format = 'via [🔰 $version](bold red) '
```
## Deno
@@ -960,13 +1015,13 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| 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 Deno |
+| `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 Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | 這個模組的風格。 |
+| `style` | `'green bold'` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -983,7 +1038,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
# ~/.config/starship.toml
[deno]
-format = "via [🦕 $version](green bold) "
+format = 'via [🦕 $version](green bold) '
```
## 資料夾
@@ -996,20 +1051,21 @@ format = "via [🦕 $version](green bold) "
### 選項
-| Option | 預設 | 說明 |
-| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `truncation_length` | `3` | 到達現在資料夾的路徑中，要被裁減掉的資料夾數目。 |
-| `truncate_to_repo` | `true` | 是否要裁減到你現在所在的 git 儲存庫的根目錄。 |
-| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
-| `style` | `"bold cyan"` | 這個模組的風格。 |
-| `disabled` | `false` | 停用 `directory` 模組。 |
-| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
-| `read_only_style` | `"red"` | The style for the read only symbol. |
-| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
-| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
-| `home_symbol` | `"~"` | The symbol indicating home directory. |
-| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
+| Option | 預設 | 說明 |
+| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `3` | 到達現在資料夾的路徑中，要被裁減掉的資料夾數目。 |
+| `truncate_to_repo` | `true` | 是否要裁減到你現在所在的 git 儲存庫的根目錄。 |
+| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |
+| `style` | `'bold cyan'` | 這個模組的風格。 |
+| `disabled` | `false` | 停用 `directory` 模組。 |
+| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
+| `read_only_style` | `'red'` | The style for the read only symbol. |
+| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
+| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
+| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
+| `home_symbol` | `'~'` | The symbol indicating home directory. |
+| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
這個模組有些進階設定選項可以控制顯示資料夾。
@@ -1024,8 +1080,8 @@ format = "via [🦕 $version](green bold) "
```toml
[directory.substitutions]
-"/Volumes/network/path" = "/net"
-"src/com/long/java/path" = "mypath"
+'/Volumes/network/path' = '/net'
+'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -1036,8 +1092,8 @@ format = "via [🦕 $version](green bold) "
| 變數 | 範例 | 說明 |
| --------- | --------------------- | ----------------------------------- |
-| path | `"D:/Projects"` | The current directory path |
-| style\* | `"black bold dimmed"` | Mirrors the value of option `style` |
+| path | `'D:/Projects'` | The current directory path |
+| style\* | `'black bold dimmed'` | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -1048,11 +1104,11 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| 變數 | 範例 | 說明 |
| ------------------ | --------------------- | --------------------------------------- |
-| before_root_path | `"/path/to/home/"` | The path before git root directory path |
-| repo_root | `"git_repo"` | The git root directory name |
-| path | `"/src/lib"` | The remaining path |
-| style | `"black bold dimmed"` | Mirrors the value of option `style` |
-| repo_root_style | `"underline white"` | Style for git root directory name |
+| before_root_path | `'/path/to/home/'` | The path before git root directory path |
+| repo_root | `'git_repo'` | The git root directory name |
+| path | `'/src/lib'` | The remaining path |
+| style | `'black bold dimmed'` | Mirrors the value of option `style` |
+| repo_root_style | `'underline white'` | Style for git root directory name |
Android
@@ -219,7 +219,6 @@ Alternatively, install Starship using any of the following package managers:
| 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` |
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` |
-| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
| Manjaro | | `pacman -S starship` |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
@@ -264,9 +263,9 @@ Install Starship using any of the following package managers:
Bash
@@ -280,7 +279,7 @@ eval "$(starship init bash)"
Cmd
+命令提示字元
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:
@@ -389,15 +388,15 @@ eval "$(starship init zsh)"
diff --git a/docs/zh-TW/presets/README.md b/docs/zh-TW/presets/README.md
index 8ac78edb1..35413ed10 100644
--- a/docs/zh-TW/presets/README.md
+++ b/docs/zh-TW/presets/README.md
@@ -10,6 +10,14 @@ This preset changes the symbols for each module to use Nerd Font symbols.
[](./nerd-font)
+## [No Nerd Fonts](./no-nerd-font.md)
+
+This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
+
+::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). :::
+
+[Click to view No Nerd Font preset](./no-nerd-font)
+
## [括號片段](./bracketed-segments.md)
這個預設樣式使所有模組使用括號片段內的格式顯示，而非使用 Starship 預設（"via", "on", etc.）。
@@ -28,6 +36,12 @@ This preset changes the symbols for each module into plain text. Great if you do
[](./no-runtimes)
+## [No Empty Icons](./no-empty-icons.md)
+
+This preset does not show icons if the toolset is not found.
+
+[](./no-empty-icons.md)
+
## [Pure Prompt](./pure-preset.md)
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
@@ -39,3 +53,9 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
[](./pastel-powerline)
+
+## [Tokyo Night](./tokyo-night.md)
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+[](./tokyo-night)
diff --git a/docs/zh-TW/presets/no-empty-icons.md b/docs/zh-TW/presets/no-empty-icons.md
new file mode 100644
index 000000000..bec3e0d1d
--- /dev/null
+++ b/docs/zh-TW/presets/no-empty-icons.md
@@ -0,0 +1,17 @@
+[Return to Presets](./README.md#no-empty-icons)
+
+# No Empty Icons Preset
+
+If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
+
+
+
+### 設定
+
+```sh
+starship preset no-empty-icons > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-empty-icons.toml)
+
+<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
diff --git a/docs/zh-TW/presets/no-nerd-font.md b/docs/zh-TW/presets/no-nerd-font.md
new file mode 100644
index 000000000..dacac623e
--- /dev/null
+++ b/docs/zh-TW/presets/no-nerd-font.md
@@ -0,0 +1,19 @@
+[Return to Presets](./README.md#no-nerd-fonts)
+
+# No Nerd Fonts Preset
+
+This preset restricts the use of symbols to those from emoji and powerline sets.
+
+This means that even without a Nerd Font installed, you should be able to view all module symbols.
+
+This preset will become the default preset in a future release of starship.
+
+### 設定
+
+```sh
+starship preset no-nerd-font > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/no-nerd-font.toml)
+
+<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
diff --git a/docs/zh-TW/presets/tokyo-night.md b/docs/zh-TW/presets/tokyo-night.md
new file mode 100644
index 000000000..e2ecc99c1
--- /dev/null
+++ b/docs/zh-TW/presets/tokyo-night.md
@@ -0,0 +1,21 @@
+[Return to Presets](./README.md#pastel-powerline)
+
+# Tokyo Night Preset
+
+This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
+
+
+
+### 先決要求
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
+
+### 設定
+
+```sh
+starship preset tokyo-night > ~/.config/starship.toml
+```
+
+[Click to download TOML](/presets/toml/tokyo-night.toml)
+
+<<< @/.vuepress/public/presets/toml/tokyo-night.toml
diff --git a/src/configs/haxe.rs b/src/configs/haxe.rs
new file mode 100644
index 000000000..70392590c
--- /dev/null
+++ b/src/configs/haxe.rs
@@ -0,0 +1,34 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Deserialize, Serialize)]
+#[cfg_attr(
+ feature = "config-schema",
+ derive(schemars::JsonSchema),
+ schemars(deny_unknown_fields)
+)]
+#[serde(default)]
+pub struct HaxeConfig<'a> {
+ pub format: &'a str,
+ pub version_format: &'a str,
+ pub symbol: &'a str,
+ pub style: &'a str,
+ pub disabled: bool,
+ pub detect_extensions: Vec<&'a str>,
+ pub detect_files: Vec<&'a str>,
+ pub detect_folders: Vec<&'a str>,
+}
+
+impl<'a> Default for HaxeConfig<'a> {
+ fn default() -> Self {
+ HaxeConfig {
+ format: "via [$symbol($version )]($style)",
+ version_format: "v${raw}",
+ symbol: "⌘ ",
+ style: "bold fg:202",
+ disabled: false,
+ detect_extensions: vec!["hx", "hxml"],
+ detect_files: vec!["haxelib.json", "hxformat.json", ".haxerc"],
+ detect_folders: vec![".haxelib", "haxe_libraries"],
+ }
+ }
+}
diff --git a/src/configs/mod.rs b/src/configs/mod.rs
index bfb5e95ac..a7717c3ac 100644
--- a/src/configs/mod.rs
+++ b/src/configs/mod.rs
@@ -35,6 +35,7 @@ pub mod git_status;
pub mod go;
pub mod guix_shell;
pub mod haskell;
+pub mod haxe;
pub mod helm;
pub mod hg_branch;
pub mod hostname;
@@ -167,6 +168,8 @@ pub struct FullConfig<'a> {
#[serde(borrow)]
haskell: haskell::HaskellConfig<'a>,
#[serde(borrow)]
+ haxe: haxe::HaxeConfig<'a>,
+ #[serde(borrow)]
helm: helm::HelmConfig<'a>,
#[serde(borrow)]
hg_branch: hg_branch::HgBranchConfig<'a>,
diff --git a/src/configs/starship_root.rs b/src/configs/starship_root.rs
index f15a6fa5f..fd67bc65c 100644
--- a/src/configs/starship_root.rs
+++ b/src/configs/starship_root.rs
@@ -59,6 +59,7 @@ pub const PROMPT_ORDER: &[&str] = &[
"erlang",
"golang",
"haskell",
+ "haxe",
"helm",
"java",
"julia",
diff --git a/src/init/starship.ps1 b/src/init/starship.ps1
index e97da7d16..4422a1ed2 100755
--- a/src/init/starship.ps1
+++ b/src/init/starship.ps1
@@ -64,7 +64,7 @@ $null = New-Module starship {
# Manually write it to console
if ($stderr.Result.Trim() -ne '') {
# Write-Error doesn't work here
- $host.ui.WriteErrorLine($stderr)
+ $host.ui.WriteErrorLine($stderr.Result)
}
$stdout.Result;
diff --git a/src/module.rs b/src/module.rs
index 41d11398b..f0d1a0e0d 100644
--- a/src/module.rs
+++ b/src/module.rs
@@ -43,6 +43,7 @@ pub const ALL_MODULES: &[&str] = &[
"golang",
"guix_shell",
"haskell",
+ "haxe",
"helm",
"hg_branch",
"hostname",
diff --git a/src/modules/haxe.rs b/src/modules/haxe.rs
new file mode 100644
index 000000000..de0a8133c
--- /dev/null
+++ b/src/modules/haxe.rs
@@ -0,0 +1,315 @@
+use super::{Context, Module, ModuleConfig};
+
+use crate::configs::haxe::HaxeConfig;
+use crate::formatter::StringFormatter;
+use crate::formatter::VersionFormatter;
+use serde_json as json;
+
+use regex::Regex;
+const HAXERC_VERSION_PATTERN: &str = "(?:[0-9a-zA-Z][-+0-9.a-zA-Z]+)";
+
+/// Creates a module with the current Haxe version
+pub fn module<'a>(context: &'a Context) -> Option