mirror of
https://github.com/starship/starship.git
synced 2026-06-23 02:05:51 +07:00
docs(i18n): new Crowdin updates (#7206)
* New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Russian) * New translations readme.md (Russian) * New translations readme.md (French) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (Arabic) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Italian) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Dutch) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Norwegian) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Portuguese) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Turkish) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Vietnamese) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Bengali) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (French) * New translations readme.md (French) * New translations readme.md (French) * New translations bracketed-segments.md (French) * New translations readme.md (French) * New translations nerd-font.md (French) * New translations no-runtimes.md (French) * New translations plain-text.md (French) * New translations pure-preset.md (French) * New translations pastel-powerline.md (French) * New translations no-nerd-font.md (French) * New translations no-empty-icons.md (French) * New translations tokyo-night.md (French) * New translations gruvbox-rainbow.md (French) * New translations jetpack.md (French) * New translations readme.md (Chinese Simplified) * New translations readme.md (French) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (French) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (German) * New translations readme.md (Japanese) * New translations readme.md (Japanese) * New translations readme.md (Russian) * New translations readme.md (Russian) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Indonesian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (German) * New translations readme.md (German) * New translations gruvbox-rainbow.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations bracketed-segments.md (German) * New translations nerd-font.md (German) * New translations no-runtimes.md (German) * New translations plain-text.md (German) * New translations pure-preset.md (German) * New translations pastel-powerline.md (German) * New translations no-nerd-font.md (German) * New translations no-empty-icons.md (German) * New translations tokyo-night.md (German) * New translations gruvbox-rainbow.md (German) * New translations jetpack.md (German) * New translations catppuccin-powerline.md (German) * New translations readme.md (Spanish) * New translations readme.md (Spanish) * New translations readme.md (German) * New translations nerd-font.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations bracketed-segments.md (German) * New translations nerd-font.md (German) * New translations no-runtimes.md (German) * New translations plain-text.md (German) * New translations pastel-powerline.md (German) * New translations no-nerd-font.md (German) * New translations no-empty-icons.md (German) * New translations tokyo-night.md (German) * New translations gruvbox-rainbow.md (German) * New translations jetpack.md (German) * New translations catppuccin-powerline.md (German) * New translations readme.md (German) * New translations readme.md (German) * New translations pure-preset.md (German) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian) * New translations readme.md (Ukrainian)
This commit is contained in:
Matan Kushner
@@ -114,7 +114,7 @@ onMounted(() => {
|
||||
```
|
||||
|
||||
|
||||
#### Powershell
|
||||
#### 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.
|
||||
|
||||
|
||||
@@ -266,6 +266,316 @@ Note: Continuation prompts are only available in the following shells:
|
||||
continuation_prompt = '▶▶ '
|
||||
```
|
||||
|
||||
## Statusline for Claude Code
|
||||
|
||||
Starship supports displaying a custom statusline when running inside Claude Code, Anthropic's CLI tool for interactive coding with Claude. This statusline provides real-time information about your Claude session, including the model being used, context window usage, and session costs.
|
||||
|
||||
For more information about the Claude Code statusline feature, see the [Claude Code statusline documentation](https://code.claude.com/docs/en/statusline).
|
||||
|
||||
### Setup
|
||||
|
||||
To use Starship as your Claude Code statusline:
|
||||
|
||||
1. Run `/statusline` in Claude Code and ask it to configure Starship, or manually add the following to your `.claude/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusLine": {
|
||||
"type": "command",
|
||||
"command": "starship statusline claude-code"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Customize the statusline appearance in your `~/.config/starship.toml` (see [Configuration](#configuration) below)
|
||||
|
||||
### Overview
|
||||
|
||||
When invoked with `starship statusline claude-code`, Starship receives Claude Code session data via stdin and renders a statusline using a dedicated profile named `claude-code`.
|
||||
|
||||
The profile includes three specialized modules:
|
||||
|
||||
- `claude_model`: Displays the current Claude model being used
|
||||
- `claude_context`: Shows context window usage with a visual gauge
|
||||
- `claude_cost`: Displays session cost and statistics
|
||||
|
||||
The default profile format is:
|
||||
|
||||
```toml
|
||||
[profiles]
|
||||
claude-code = "$claude_model$git_branch$claude_context$claude_cost"
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
You can customize the Claude Code statusline by modifying the `claude-code` profile and individual module configurations in your `~/.config/starship.toml`:
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# Customize the claude-code profile
|
||||
[profiles]
|
||||
claude-code = "$claude_model$claude_context$claude_cost"
|
||||
|
||||
# Configure individual modules
|
||||
[claude_model]
|
||||
format = "[$symbol$model]($style) "
|
||||
symbol = "🤖 "
|
||||
style = "bold blue"
|
||||
|
||||
[claude_context]
|
||||
format = "[$gauge $percentage]($style) "
|
||||
gauge_width = 10
|
||||
|
||||
[claude_cost]
|
||||
format = "[$symbol$cost]($style) "
|
||||
symbol = "💰 "
|
||||
```
|
||||
|
||||
### Claude Model
|
||||
|
||||
The `claude_model` module displays the current Claude model being used in the session.
|
||||
|
||||
#### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| --------------- | ---------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol$model]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🤖 '` | The symbol shown before the model name. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `model_aliases` | `{}` | Map of model IDs or display names to shorter aliases. Checks ID first, then display name. |
|
||||
| `disabled` | `false` | Disables the `claude_model` module. |
|
||||
|
||||
#### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| --------- | ------------------- | ------------------------------------- |
|
||||
| model | `Claude 3.5 Sonnet` | The display name of the current model |
|
||||
| model_id | `claude-3-5-sonnet` | The model ID |
|
||||
| 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
|
||||
|
||||
#### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# Basic customization
|
||||
[claude_model]
|
||||
format = "on [$symbol$model]($style) "
|
||||
symbol = "🧠 "
|
||||
style = "bold cyan"
|
||||
|
||||
# Using model aliases for vendor-specific model names
|
||||
# You can alias by model ID or display name
|
||||
[claude_model.model_aliases]
|
||||
# Alias by vendor model ID (e.g. AWS Bedrock)
|
||||
"global.anthropic.claude-sonnet-4-5-20250929-v1:0" = "Sonnet 4.5"
|
||||
# Alias by display name
|
||||
"Claude Sonnet 4.5 (Vendor Proxy)" = "Sonnet"
|
||||
```
|
||||
|
||||
### Claude Context
|
||||
|
||||
The `claude_context` module displays context window usage as a percentage and visual gauge. The style automatically changes based on configurable thresholds.
|
||||
|
||||
#### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ---------------------- | --------------------------------- | -------------------------------------------------- |
|
||||
| `format` | `'[$gauge $percentage]($style) '` | The format for the module. |
|
||||
| `symbol` | `''` | The symbol shown before the gauge. |
|
||||
| `gauge_width` | `5` | The width of the gauge in characters. |
|
||||
| `gauge_full_symbol` | `'█'` | The symbol used for filled segments of the gauge. |
|
||||
| `gauge_partial_symbol` | `'▒'` | The symbol used for partial segments of the gauge. |
|
||||
| `gauge_empty_symbol` | `'░'` | The symbol used for empty segments of the gauge. |
|
||||
| `display` | [see below](#display) | Threshold and style configurations. |
|
||||
| `disabled` | `false` | Disables the `claude_context` module. |
|
||||
|
||||
##### Display
|
||||
|
||||
The `display` option is an array of objects that define thresholds and styles for different usage levels. The module uses the style from the highest matching threshold or hides the module if `hidden` is `true`.
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ----------- | ------------ | ------------------------------------------------------------------------ |
|
||||
| `threshold` | `0.0` | The minimum context windows usage percentage to match this configuration |
|
||||
| `style` | `bold green` | The value of `style` if this display configuration is matched |
|
||||
| `hidden` | `false` | Hide this module if this the configuration is matched. |
|
||||
|
||||
```toml
|
||||
[[claude_context.display]]
|
||||
threshold = 0
|
||||
hidden = true
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 30
|
||||
style = "bold green"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 60
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 80
|
||||
style = "bold red"
|
||||
```
|
||||
|
||||
#### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| ---------------------------- | ------- | ----------------------------------------------------- |
|
||||
| gauge | `██▒░░` | Visual representation of context usage |
|
||||
| percentage | `65%` | Context usage as a percentage |
|
||||
| input_tokens | `45.2k` | Total input tokens in conversation |
|
||||
| output_tokens | `12.3k` | Total output tokens in conversation |
|
||||
| curr_input_tokens | `5.1k` | Input tokens from most recent API call |
|
||||
| curr_output_tokens | `1.2k` | Output tokens from most recent API call |
|
||||
| curr_cache_creation_tokens | `1.5k` | Cache creation tokens from most recent API call |
|
||||
| curr_cache_read_tokens | `23.4k` | Cache read tokens from most recent API call |
|
||||
| total_tokens | `200k` | Total context window size |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
#### Examples
|
||||
|
||||
**Minimal gauge-only display**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[claude_context]
|
||||
format = "[$gauge]($style) "
|
||||
gauge_width = 10
|
||||
```
|
||||
|
||||
**Detailed token information**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[claude_context]
|
||||
format = "[$percentage ($input_tokens in / $output_tokens out)]($style) "
|
||||
```
|
||||
|
||||
**Custom gauge symbols**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[claude_context]
|
||||
gauge_full_symbol = "▰"
|
||||
gauge_partial_symbol = ""
|
||||
gauge_empty_symbol = "▱"
|
||||
gauge_width = 10
|
||||
format = "[$gauge]($style) "
|
||||
```
|
||||
|
||||
**Custom thresholds**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 0
|
||||
style = "bold green"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 50
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 75
|
||||
style = "bold orange"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 90
|
||||
style = "bold red"
|
||||
```
|
||||
|
||||
### Claude Cost
|
||||
|
||||
The `claude_cost` module displays the total cost of the current Claude Code session in USD. Like `claude_context`, it supports threshold-based styling.
|
||||
|
||||
#### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ---------- | ---------------------------------- | ----------------------------------- |
|
||||
| `format` | `'[$symbol(\\$$cost)]($style) '` | The format for the module. |
|
||||
| `symbol` | `'💰 '` | The symbol shown before the cost. |
|
||||
| `display` | [see below](#display-1) | Threshold and style configurations. |
|
||||
| `disabled` | `false` | Disables the `claude_cost` module. |
|
||||
|
||||
##### Display
|
||||
|
||||
The `display` option is an array of objects that define cost thresholds and styles. The module uses the style from the highest matching threshold or hides the module if `hidden` is `true`.
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ----------- | ------------ | ------------------------------------------------------------- |
|
||||
| `threshold` | `0.0` | The minimum cost in USD to match this configuration |
|
||||
| `style` | `bold green` | The value of `style` if this display configuration is matched |
|
||||
| `hidden` | `false` | Hide this module if this configuration is matched. |
|
||||
|
||||
**Default configuration:**
|
||||
|
||||
```toml
|
||||
[[claude_cost.display]]
|
||||
threshold = 0.0
|
||||
hidden = true
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 1.0
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 5.0
|
||||
style = "bold red"
|
||||
```
|
||||
|
||||
#### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| ------------- | -------- | ----------------------------------------------------- |
|
||||
| cost | `1.23` | Total session cost in USD (formatted to 2 decimals) |
|
||||
| duration | `1m 30s` | Total session duration |
|
||||
| api_duration | `45s` | Total API call duration |
|
||||
| lines_added | `1.2k` | Total lines of code added |
|
||||
| lines_removed | `500` | Total lines of code removed |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
#### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# Cost with code change statistics
|
||||
[claude_cost]
|
||||
format = "[$symbol$cost (+$lines_added -$lines_removed)]($style) "
|
||||
|
||||
# Hide module until cost exceeds $0.10
|
||||
[[claude_cost.display]]
|
||||
threshold = 0.0
|
||||
hidden = true
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 0.10
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 2.0
|
||||
style = "bold red"
|
||||
|
||||
# Show duration information
|
||||
[claude_cost]
|
||||
format = "[$symbol$cost ($duration)]($style) "
|
||||
```
|
||||
|
||||
## Style Strings
|
||||
|
||||
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
|
||||
|
||||
+189
-70
@@ -253,6 +253,7 @@ $localip\
|
||||
$shlvl\
|
||||
$singularity\
|
||||
$kubernetes\
|
||||
$nats\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$fossil_branch\
|
||||
@@ -267,9 +268,11 @@ $hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
$bun\
|
||||
$c\
|
||||
$cmake\
|
||||
$cobol\
|
||||
$cpp\
|
||||
$daml\
|
||||
$dart\
|
||||
$deno\
|
||||
@@ -281,18 +284,20 @@ $fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
$gradle\
|
||||
$haskell\
|
||||
$haxe\
|
||||
$helm\
|
||||
$java\
|
||||
$julia\
|
||||
$kotlin\
|
||||
$gradle\
|
||||
$lua\
|
||||
$maven\
|
||||
$mojo\
|
||||
$nim\
|
||||
$nodejs\
|
||||
$ocaml\
|
||||
$odin\
|
||||
$opa\
|
||||
$perl\
|
||||
$php\
|
||||
@@ -312,10 +317,13 @@ $terraform\
|
||||
$typst\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$xmake\
|
||||
$zig\
|
||||
$buf\
|
||||
$guix_shell\
|
||||
$nix_shell\
|
||||
$conda\
|
||||
$pixi\
|
||||
$meson\
|
||||
$spack\
|
||||
$memory_usage\
|
||||
@@ -323,7 +331,6 @@ $aws\
|
||||
$gcloud\
|
||||
$openstack\
|
||||
$azure\
|
||||
$nats\
|
||||
$direnv\
|
||||
$env_var\
|
||||
$mise\
|
||||
@@ -336,9 +343,9 @@ $jobs\
|
||||
$battery\
|
||||
$time\
|
||||
$status\
|
||||
$os\
|
||||
$container\
|
||||
$netns\
|
||||
$os\
|
||||
$shell\
|
||||
$character"""
|
||||
```
|
||||
@@ -498,7 +505,7 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
| `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. |
|
||||
| `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. |
|
||||
@@ -566,7 +573,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
|
||||
| `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. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `elixir` module. |
|
||||
|
||||
@@ -1140,11 +1147,31 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
|
||||
|
||||
| Advanced Option | الافتراضي | الوصف |
|
||||
| --------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `substitutions` | | A table of substitutions to be made to the path. |
|
||||
| `substitutions` | | An Array or table of substitutions to be made to the path. |
|
||||
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
|
||||
| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
|
||||
|
||||
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD.
|
||||
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD. It takes an array of the following key/value pairs:
|
||||
|
||||
| Value | Type | الوصف |
|
||||
| ------- | ------- | ---------------------------------------- |
|
||||
| `from` | String | The value to substitute |
|
||||
| `to` | String | The replacement for that value, if found |
|
||||
| `regex` | Boolean | (Optional) Whether `from` is a regex |
|
||||
|
||||
By using `regex = true`, you can use [Rust's regular expressions](https://docs.rs/regex/latest/regex/#syntax) in `from`. For instance you can replace every slash except the first with the following:
|
||||
|
||||
```toml
|
||||
substitutions = [
|
||||
{ from = "^/", to = "<root>/", regex = true },
|
||||
{ from = "/", to = " | " },
|
||||
{ from = "^<root>", to = "/", regex = true },
|
||||
]
|
||||
```
|
||||
|
||||
This will replace `/var/log` to `/ | var | log`.
|
||||
|
||||
The old syntax still works, although it doesn't support regular expressions:
|
||||
|
||||
```toml
|
||||
[directory.substitutions]
|
||||
@@ -1302,7 +1329,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `['csproj', 'fsproj', 'xproj']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `dotnet` module. |
|
||||
|
||||
@@ -1343,7 +1370,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| `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. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `elixir` module. |
|
||||
|
||||
@@ -1386,7 +1413,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| `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. |
|
||||
| `detect_folders` | `['elm-stuff']` | Which folders should trigger this module. |
|
||||
| `style` | `'cyan bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `elm` module. |
|
||||
|
||||
@@ -1430,14 +1457,15 @@ The `env_var` module displays the current value of a selected environment variab
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ----------- | ------------------------------ | ---------------------------------------------------------------------------- |
|
||||
| `symbol` | `""` | The symbol used before displaying the variable value. |
|
||||
| `variable` | | The environment variable to be displayed. |
|
||||
| `الافتراضي` | | The default value to be displayed when the selected variable is not defined. |
|
||||
| `format` | `"with [$env_value]($style) "` | The format for the module. |
|
||||
| `الوصف` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
|
||||
| `disabled` | `false` | Disables the `env_var` module. |
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ----------- | ------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `symbol` | `""` | The symbol used before displaying the variable value. |
|
||||
| `variable` | | The environment variable to be displayed. |
|
||||
| `الافتراضي` | | The default value to be displayed when the selected variable is not defined. |
|
||||
| `format` | `"with [$symbol$env_value]($style) "` | The format for the module. |
|
||||
| `الوصف` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
|
||||
| `disabled` | `false` | Disables the `env_var` module. |
|
||||
| `style` | `"black bold dimmed"` | The style for the module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1445,7 +1473,7 @@ The `env_var` module displays the current value of a selected environment variab
|
||||
| --------- | ------------------------------------------- | ------------------------------------------ |
|
||||
| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | `black bold dimmed` | 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
|
||||
|
||||
@@ -1488,7 +1516,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| `style` | `'bold red'` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['rebar.config', 'elang.mk']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `erlang` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1526,7 +1554,7 @@ The `fennel` module shows the currently installed version of [Fennel](https://fe
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `detect_extensions` | `['fnl']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `fennel` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1931,44 +1959,60 @@ The `git_status` module shows symbols representing the state of the repo in your
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| -------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | This branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format of `ahead` |
|
||||
| `behind` | `'⇣'` | The format of `behind` |
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
| `deleted` | `'✘'` | The format of `deleted` |
|
||||
| `typechanged` | `""` | The format of `typechanged` |
|
||||
| `style` | `'bold red'` | The style for the module. |
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `disabled` | `false` | Disables the `git_status` module. |
|
||||
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
|
||||
| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ---------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | The format shown when this branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format shown when this branch is ahead of the branch being tracked. |
|
||||
| `behind` | `'⇣'` | The format shown when this branch is behind the branch being tracked. |
|
||||
| `diverged` | `'⇕'` | The format shown when this branch has diverged from the branch being tracked. |
|
||||
| `up_to_date` | `''` | The format shown when this branch is up to date with the branch being tracked. |
|
||||
| `untracked` | `'?'` | The format shown when there are untracked files in the working directory. |
|
||||
| `stashed` | `'\$'` | The format shown when a stash exists for the local repository. |
|
||||
| `modified` | `'!'` | The format shown when there are file modifications in the working directory. |
|
||||
| `staged` | `'+'` | The format shown when a new file has been added to the staging area. |
|
||||
| `renamed` | `'»'` | The format shown when a renamed file has been added to the staging area. |
|
||||
| `deleted` | `'✘'` | The format shown when a file's deletion has been added to the staging area. |
|
||||
| `typechanged` | `""` | The format shown when a file's type has been changed in the staging area. |
|
||||
| `style` | `'bold red'` | The style for the module. |
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `worktree_added` | `""` | The format shown when a new file has been added in the working directory. |
|
||||
| `worktree_deleted` | `""` | The format shown when a file has been deleted in the working directory. |
|
||||
| `worktree_modified` | `""` | The format shown when a file has been modified in the working directory. |
|
||||
| `worktree_typechanged` | `""` | The format shown when a file's type has been changed in the working directory. |
|
||||
| `index_added` | `""` | The format shown when a new file has been added to the staging area. |
|
||||
| `index_deleted` | `""` | The format shown when a file has been deleted from the staging area. |
|
||||
| `index_modified` | `""` | The format shown when a file has been modified in the staging area. |
|
||||
| `index_typechanged` | `""` | The format shown when a file's type has been changed in the staging area. |
|
||||
| `disabled` | `false` | Disables the `git_status` module. |
|
||||
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
|
||||
| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |
|
||||
|
||||
### Variables
|
||||
|
||||
The following variables can be used in `format`:
|
||||
|
||||
| Variable | الوصف |
|
||||
| -------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` |
|
||||
| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |
|
||||
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
|
||||
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
|
||||
| `stashed` | Displays `stashed` when a stash exists for the local repository. |
|
||||
| `modified` | Displays `modified` when there are file modifications in the working directory. |
|
||||
| `staged` | Displays `staged` when a new file has been added to the staging area. |
|
||||
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
|
||||
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
|
||||
| `typechanged` | Displays `typechanged` when a file's type has been changed in the staging area. |
|
||||
| style\* | Mirrors the value of option `style` |
|
||||
| Variable | الوصف |
|
||||
| ---------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `all_status` | Shortcut for `$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked`. |
|
||||
| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |
|
||||
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
|
||||
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
|
||||
| `stashed` | Displays `stashed` when a stash exists for the local repository. |
|
||||
| `modified` | Displays `modified` when there are file modifications in the working directory. |
|
||||
| `staged` | Displays `staged` when a new file has been added to the staging area. |
|
||||
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
|
||||
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
|
||||
| `typechanged` | Displays `typechanged` when a file's type has been changed in the staging area. |
|
||||
| `worktree_added` | Displays `worktree_added` when a new file has been added in the working directory. |
|
||||
| `worktree_deleted` | Displays `worktree_deleted` when a file's been deleted in the working directory. |
|
||||
| `worktree_modified` | Displays `worktree_modified` when a file's been modified in the working directory. |
|
||||
| `worktree_typechanged` | Displays `worktree_typechanged` when a file's type has been changed in the working directory. |
|
||||
| `index_added` | Displays `index_added` when a new file has been added to the staging area. |
|
||||
| `index_deleted` | Displays `index_deleted` when a file has been deleted from the staging area. |
|
||||
| `index_modified` | Displays `index_modified` when a file has been modified in the staging area. |
|
||||
| `index_typechanged` | Displays `index_typechanged` when a file's type has been changed in the staging area. |
|
||||
| style\* | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
@@ -1979,7 +2023,7 @@ The following variables can be used in `diverged`:
|
||||
| `ahead_count` | Number of commits ahead of the tracking branch |
|
||||
| `behind_count` | Number of commits behind the tracking branch |
|
||||
|
||||
The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:
|
||||
The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed`, `deleted`, `typechanged`, `worktree_added`, `worktree_deleted`, `worktree_modified`, `worktree_typechanged`, `index_added`, `index_deleted`, `index_modified`, and `index_typechanged`:
|
||||
|
||||
| Variable | الوصف |
|
||||
| -------- | ------------------------ |
|
||||
@@ -2235,7 +2279,7 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o
|
||||
| `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. |
|
||||
| `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this module. |
|
||||
| `symbol` | `'⌘ '` | A format string representing the symbol of Haxe. |
|
||||
| `style` | `'bold fg:202'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `haxe` module. |
|
||||
@@ -2274,7 +2318,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. |
|
||||
| `style` | `'bold white'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `helm` module. |
|
||||
@@ -2373,7 +2417,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `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', '.sdkmanrc']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'☕ '` | A format string representing the symbol of Java |
|
||||
| `style` | `'red dimmed'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `java` module. |
|
||||
@@ -2470,7 +2514,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['jl']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['Project.toml', 'Manifest.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `julia` module. |
|
||||
@@ -2508,7 +2552,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['kt', 'kts']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. |
|
||||
@@ -2562,7 +2606,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
|
||||
| `user_aliases`* | `{}` | Table of user aliases to display. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
|
||||
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
|
||||
| `disabled` | `true` | Disables the `kubernetes` module. |
|
||||
@@ -2745,6 +2789,41 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
format = 'via [🌕 $version](bold blue) '
|
||||
```
|
||||
|
||||
## Maven
|
||||
|
||||
The `maven` module indicates the presence of a Maven project in the current directory. If the [Maven Wrapper](https://maven.apache.org/wrapper/) is enabled, the Maven version will be parsed from `.mvn/wrapper/maven-wrapper.properties` and shown.
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `pom.xml` file.
|
||||
- The current directory contains a `.mvn/wrapper/maven-wrapper.properties` file.
|
||||
|
||||
If you use an alternate POM syntax (for example `pom.hocon`), add its filename to `detect_files`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🅼 '` | A format string representing the symbol of Maven. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pom.xml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.mvn']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold bright-cyan'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `maven` module. |
|
||||
| `recursive` | `false` | Enables recursive finding for the `.mvn` directory. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| -------- | -------- | ------------------------------------ |
|
||||
| version | `v3.2.0` | The version of `maven` |
|
||||
| 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
|
||||
|
||||
## Memory Usage
|
||||
|
||||
The `memory_usage` module shows current system memory and swap usage.
|
||||
@@ -3749,6 +3828,7 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `generic_venv_names` | `[]` | Which venv names should be replaced with the parent directory name. |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
|
||||
> [!TIP] The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
|
||||
@@ -3757,13 +3837,13 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| ------------ | --------------- | ------------------------------------------ |
|
||||
| version | `'v3.8.1'` | The version of `python` |
|
||||
| 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 |
|
||||
| Variable | مثال | الوصف |
|
||||
| ------------ | --------------- | --------------------------------------------------------------------------- |
|
||||
| version | `'v3.8.1'` | The version of `python` |
|
||||
| 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 or the parent if matches `generic_venv_names` |
|
||||
|
||||
### مثال
|
||||
|
||||
@@ -4043,7 +4123,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['sbt', 'scala']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.metals']` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `['.metals']` | Which folders should trigger this module. |
|
||||
| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. |
|
||||
| `style` | `'red dimmed'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `scala` module. |
|
||||
@@ -4665,6 +4745,45 @@ The `vlang` module shows you your currently installed version of [V](https://vla
|
||||
format = 'via [V $version](blue bold) '
|
||||
```
|
||||
|
||||
## VCS
|
||||
|
||||
> Note the module is enabled by default but **not** included in the default list because that would be a breaking change. Additionally, the exact format of the module may change in the future, for example to handle right-aligned prompt.
|
||||
|
||||
The `vcs` module displays the current active Version Control System (VCS). The module will be shown only if a configured VCS is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ---------------- | ----------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `order` | `["git", "hg", "pijul", "fossil"]` | The order in which to search VCSes. |
|
||||
| `fossil_modules` | `"$fossil_branch$fossil_metrics"` | Modules to show when a Fossil repository is found. |
|
||||
| `git_modules` | `"$git_branch$git_commit$git_state$git_metrics$git_status"` | Modules to show when a Git repository is found. |
|
||||
| `hg_modules` | `"$hg_branch$hg_state"` | Modules to show when a Mercurial repository is found. |
|
||||
| `pijul_modules` | `"$pijul_channel"` | Modules to show when a Pijul repository is found. |
|
||||
| `disabled` | `false` | Disables the `vcs` module. |
|
||||
|
||||
### مثال
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcs]
|
||||
# Will look for Git then Pijul if not found but not for other VCSes at all
|
||||
order = [
|
||||
"git",
|
||||
"pijul",
|
||||
]
|
||||
# Any module (except `$vcs` itself to avoid infinite loops) can be included here
|
||||
git_modules = "$git_branch${custom.foo}"
|
||||
|
||||
# See documentation for custom modules
|
||||
[custom.foo]
|
||||
command = 'echo foo'
|
||||
detect_files = ['foo']
|
||||
when = ''' test "$HOME" = "$PWD" '''
|
||||
format = ' transcending [$output]($style)'
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
@@ -408,7 +408,7 @@ If you're looking to further customize Starship:
|
||||
|
||||
## 🤝 المساهمة
|
||||
|
||||
نبحث دائماً عن مساهمين من **جميع المستويات**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
نبحث دائماً عن مساهمين من **جميع المستويات**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/issues?q=state%3Aopen%20label%3A%22%F0%9F%8C%B1%20good%20first%20issue%22).
|
||||
|
||||
إذا كنت تتحدث بطلاقة بلغة غير إنجليزية، فإننا نقدر أي مساعدة للحفاظ على ترجمة المستندات وتحديثها بلغات أخرى. إذا كنت ترغب في المساعدة، يمكن المساهمة بالترجمة على [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user