mirror of
https://github.com/starship/starship.git
synced 2024-11-25 17:54:08 +01:00
docs(i18n): New Crowdin updates (#2469)
* New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * 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 (Sorani (Kurdish)) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Traditional) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Russian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (French) * New translations README.md (German) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Russian) * New translations README.md (Arabic) * New translations README.md (Turkish) * New translations README.md (Spanish) * New translations README.md (German) * New translations README.md (Italian) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Chinese Simplified) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (German) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * 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 (Polish) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Arabic) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (French) * New translations README.md (Japanese) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Japanese) * New translations README.md (Portuguese) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Russian) * New translations README.md (Italian) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Russian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Turkish) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * New translations README.md (Italian) * 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 (Sorani (Kurdish)) * New translations README.md (German) * New translations README.md (French) * New translations README.md (Spanish) * New translations README.md (Arabic) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Russian) * New translations README.md (Vietnamese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Korean) * New translations README.md (Italian) * New translations README.md (Japanese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean)
This commit is contained in:
Matan Kushner
GitHub
parent
c7d5ce72b5
commit
85dc3660b1
@ -40,6 +40,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Advanced Configuration
|
||||
# الإعداد المتقدم
|
||||
|
||||
While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship.
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,6 +40,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -35,16 +35,17 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
|
||||
|
||||
#### Neueste Version installieren
|
||||
|
||||
With Shell:
|
||||
Mit Shell:
|
||||
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Installation mithilfe eines Paket-Managers
|
||||
|
||||
Mit [Homebrew](https://brew.sh/):
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
Um mit der Konfiguration von Starship zu beginnen, musst du die folgende Datei erstellen: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
Die gesamte Konfiguration von Starship wird über diese [TOML](https://github.com/toml-lang/toml)-Datei durchgeführt:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Deaktiviert das `aws`-Modul. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| -------------------- | --------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `full_symbol` | `""` | Das Symbol das angezeigt wird wenn der Akku voll geladen ist. |
|
||||
| `charging_symbol` | `""` | Das Symbol das angezeigt wird wenn der Akku aufgeladen wird. |
|
||||
| `discharging_symbol` | `""` | Das Symbol, das angezeigt wird, wenn die Batterie entladen wird. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | Das Symbol das angezeigt wird wenn der Akku voll geladen ist. |
|
||||
| `charging_symbol` | `" "` | Das Symbol das angezeigt wird wenn der Akku aufgeladen wird. |
|
||||
| `discharging_symbol` | `" "` | Das Symbol, das angezeigt wird, wenn die Batterie entladen wird. |
|
||||
| `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) | Stellt den Grenzwert ein ab dem der Ladezustand (das battery-Modul) angezeigt wird. |
|
||||
| `disabled` | `false` | Wenn der Wert auf `true` steht, wird das Akkustand-Modul deaktiviert. |
|
||||
|
||||
|
||||
### Beispiel
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Anzeige des Akkustandes
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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"` | Stil für dieses Modul. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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"` | Stil für dieses Modul. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | Symbol das vor der dotnet-Version angezeigt wird. |
|
||||
| `symbol` | `".NET "` | Symbol das vor der dotnet-Version angezeigt wird. |
|
||||
| `heuristic` | `true` | Schnelle Versionserkennung nutzen um Starship bedienbar zu halten. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | Stil für dieses Modul. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | Stil für dieses Modul. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | Stil für dieses Modul. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | Stil für dieses Modul. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | Stil für dieses Modul. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | Stil für dieses Modul. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | Stil für dieses Modul. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | Stil für dieses Modul. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | Stil für dieses Modul. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | Stil für dieses Modul. |
|
||||
| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. |
|
||||
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Beispiel
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Optionen
|
||||
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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"` | Stil für dieses Modul. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"cyan bold"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ---------- | -------------------------------- | ------------------------------------------------------ |
|
||||
| `symbol` | | The symbol used before displaying the repository name. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. |
|
||||
| `disabled` | `false` | Disables the `vcsh` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | ------------------------------------------- | ------------------------------------ |
|
||||
| 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
|
||||
|
||||
### Beispiel
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,12 +106,12 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
|
||||
alt="Tiếng Việt"
|
||||
alt="Vietnamesisch"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
@ -124,7 +124,7 @@
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!**
|
||||
**Der minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!**
|
||||
|
||||
- **Fast:** it's fast – _really really_ fast! 🚀
|
||||
- **Customizable:** configure every aspect of your prompt.
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Installation mithilfe eines Paket-Managers
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Migrating to v0.45.0
|
||||
# Migration auf v0.45.0
|
||||
|
||||
Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization.
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,11 +40,12 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Instalar con un gestor de paquetes
|
||||
|
||||
Con [Homebrew](https://brew.sh/):
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ Por ejemplo, si quieres mostrar tu directorio actual en el título de la pestañ
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l)
|
||||
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
|
||||
```
|
||||
|
||||
The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations.
|
||||
La [implementación de Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) integrada en Starship es un poco más compleja para permitir funciones avanzadas como el [módulo Duración del Comando](https://starship.rs/config/#command-duration) y para garantizar que Starship sea compatible con las configuraciones de Bash preinstaladas.
|
||||
|
||||
Para obtener una lista de todos los parámetros aceptados por `el prompt de Starship`, usa el siguiente comando:
|
||||
|
||||
@ -91,6 +91,6 @@ Si Starship fue instalado usando un gestor de paquetes, por favor refiérete a s
|
||||
Si Starship fue instalado usando el script `curl | bash`, el siguiente comando eliminará el binario:
|
||||
|
||||
```sh
|
||||
# Localiza y elimina el binario de starship
|
||||
rm "$(which starship)"
|
||||
# Locate and delete the starship binary
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Francés"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Instalar con un gestor de paquetes
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarativo, usuario único, a través de [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Activa el módulo `programs.starship` en tu archivo `home.nix` y añade tus ajustes
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,11 +40,12 @@ description: Starship est un invite minimaliste, ultra-rapide et hautement perso
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Installer via le gestionnaire de paquets
|
||||
|
||||
Avec [Homebrew](https://brew.sh/):
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: Starship est un invite minimaliste, ultra-rapide et hautement perso
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ Par exemple, si vous voulez afficher votre répertoire actuel dans votre titre d
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
Pour commencer à configurer starship, créez le fichier suivant : `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
Toute la configuration de starship est faite dans ce fichier [TOML](https://github.com/toml-lang/toml):
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | Le symbole affiché avant le profil AWS actuel. |
|
||||
| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `AWS`. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | 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. |
|
||||
| `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`. |
|
||||
|
||||
|
||||
### Exemple
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Indicateur de batterie
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | --------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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"` | Le style du module. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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"` | Le style du module. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Format du module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | Format du module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | Le style du module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
| Variable | Exemple | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Format du module. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Format du module. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | Le style du module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | Le style du module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | Format du module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ---------- | -------------------------------------- |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | --------- | -------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
| Variable | Exemple | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | Format du module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | Le style du module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | Le style du module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | Le style du module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | Format du module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format du module. |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | Le style du 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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Exemple
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Exemples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | Format du module. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
| Option | Défaut | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | Format du module. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ------- | -------------------------------------- |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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"` | Le style du module. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"cyan bold"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ---------- | -------------------------------- | ------------------------------------------------------ |
|
||||
| `symbol` | | The symbol used before displaying the repository name. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `format` | `"vcsh [$symbol$repo]($style) "` | Format du module. |
|
||||
| `disabled` | `false` | Disables the `vcsh` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ------------------------------------------- | -------------------------------------- |
|
||||
| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Exemple
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -91,6 +91,6 @@ If Starship was installed using a package manager, please refer to their docs fo
|
||||
If Starship was installed using the `curl | bash` script, the following command will delete the binary:
|
||||
|
||||
```sh
|
||||
# Localiser et supprimer l'exécutable de Starship
|
||||
rm "$(which starship)"
|
||||
# Locate and delete the starship binary
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Espagnol"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Installer via le gestionnaire de paquets
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Déclaration, utilisateur unique, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,11 +40,12 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh <unk> bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Installa con Package Manager
|
||||
|
||||
Con [Homebrew](https://brew.sh/):
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ Ad esempio, se desideri visualizzare la directory corrente nel titolo della sche
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -91,6 +91,6 @@ If Starship was installed using a package manager, please refer to their docs fo
|
||||
If Starship was installed using the `curl | bash` script, the following command will delete the binary:
|
||||
|
||||
```sh
|
||||
# Individua ed elimina il binario di Starship
|
||||
rm "$(che starship)"
|
||||
# Locate and delete the starship binary
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Spagnolo"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Francese"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Installa via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,11 +40,12 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### パッケージマネージャー経由でインストール
|
||||
|
||||
[ Homebrew ](https://brew.sh/)の場合：
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ precmd_functions+=(set_win_title)
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
@ -82,7 +82,7 @@ starship_precmd_user_func="set_win_title"
|
||||
|
||||
ここで、 `<color>` は色を指定します（以下で述べます）。 `fg:<color>` と `<color>` は現在同様の動作ですが、将来変更される可能性があります。 文字列中の単語の順序は関係ありません。
|
||||
|
||||
`none` トークンは、文字列中の`bg:` 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、`fg:red none fg:blue` と指定した場合、スタイルなしの文字列が作られます。 `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。
|
||||
`none` トークンは、文字列中の`bg:` 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、`fg:red none fg:blue` と指定した場合、スタイルなしの文字列が作られます。 `bg:none` は背景色をデフォルトの色にセットするので、`fg:red bg:none` は `red` や `fg:red` と同じ意味になり、`bg:green fg:red bg:none` も `fg:red` や `red` と同じ意味になります。 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。
|
||||
|
||||
色は以下のいずれか1つを指定できます。
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
Starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。
|
||||
@ -181,6 +181,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -249,7 +250,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
|
||||
| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | `aws`モジュールを無効にします。 |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
@ -311,25 +312,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| -------------------- | --------------------------------- | ------------------------- |
|
||||
| `full_symbol` | `""` | バッテリーが満タンのときに表示される記号です。 |
|
||||
| `charging_symbol` | `""` | バッテリーの充電中に表示される記号です。 |
|
||||
| `discharging_symbol` | `""` | バッテリーが放電しているときに表示される記号です。 |
|
||||
| `unknown_symbol` | `""` | バッテリー状態が不明なときに表示される記号です。 |
|
||||
| `empty_symbol` | `""` | バッテリーが空のときに表示される記号です。 |
|
||||
| `full_symbol` | `" "` | バッテリーが満タンのときに表示される記号です。 |
|
||||
| `charging_symbol` | `" "` | バッテリーの充電中に表示される記号です。 |
|
||||
| `discharging_symbol` | `" "` | バッテリーが放電しているときに表示される記号です。 |
|
||||
| `unknown_symbol` | `" "` | バッテリー状態が不明なときに表示される記号です。 |
|
||||
| `empty_symbol` | `" "` | バッテリーが空のときに表示される記号です。 |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | moduleのフォーマットです。 |
|
||||
| `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 |
|
||||
| `disabled` | `false` | `battery`モジュールを無効にします。 |
|
||||
|
||||
|
||||
### 設定例
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### バッテリーの表示
|
||||
@ -439,7 +439,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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"` | モジュールのスタイルです。 |
|
||||
@ -596,7 +596,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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"` | モジュールのスタイルです。 |
|
||||
@ -746,7 +746,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `•NET "` | dotnetのバージョンを表示する前に使用される記号です。 |
|
||||
| `symbol` | `".NET "` | dotnetのバージョンを表示する前に使用される記号です。 |
|
||||
| `heuristic` | `true` | より高速なバージョン検出を使用して、starshipの動作を維持します。 |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -932,34 +932,34 @@ format = "via [e $version](bold red) "
|
||||
|
||||
## Gcloud
|
||||
|
||||
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
|
||||
`gcloud` モジュールは、 [`gcloud`](https://cloud.google.com/sdk/gcloud) CLIの現在の設定が表示されます。 これは `~/.config/gcloud/active_config` ファイルと `~/.config/gcloud/configurations/config_{CONFIG NAME}` ファイルと `CLOUDSDK_CONFIG` 環境変数に基づきます。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol$account(\($region\))]($style) '` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the GCP name. |
|
||||
| `style` | `"bold blue"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `gcloud` module. |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ---------------- | ------------------------------------------------ | ----------------------------- |
|
||||
| `format` | `'on [$symbol$account(\($region\))]($style) '` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"☁️ "` | 現在のGCPプロファイルを表示する前に表示される記号です。 |
|
||||
| `region_aliases` | | GCP名に加えて表示するリージョンのエイリアスです。 |
|
||||
| `style` | `"bold blue"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | `gcloud`モジュールを無効にします。 |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ----------------- | ------------------------------------------------------------------ |
|
||||
| region | `us-central1` | The current GCP region |
|
||||
| account | `foo@example.com` | The current GCP profile |
|
||||
| project | | The current GCP project |
|
||||
| active | `default` | The active config name written in `~/.config/gcloud/active_config` |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ----------------- | ----------------------------------------------- |
|
||||
| region | `us-central1` | 現在のGCPリージョン |
|
||||
| account | `foo@example.com` | 現在のGCPプロファイル |
|
||||
| project | | 現在のGCPプロジェクト |
|
||||
| active | `default` | `~/.config/gcloud/active_config` に書かれたアクティブな設定名 |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
\*: この変数はスタイル文字列の一部としてのみ使用できます
|
||||
|
||||
### 設定例
|
||||
|
||||
#### Display account and project
|
||||
#### アカウントとプロジェクトを表示
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@ -968,7 +968,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
|
||||
format = 'on [$symbol$account(\($project\))]($style) '
|
||||
```
|
||||
|
||||
#### Display active config name only
|
||||
#### アクティブな設定名のみ表示
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@ -978,7 +978,7 @@ format = "[$symbol$active]($style) "
|
||||
style = "bold yellow"
|
||||
```
|
||||
|
||||
#### Display account and aliased region
|
||||
#### アカウントとエイリアスされたリージョンを表示する
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@ -1002,20 +1002,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | モジュールのスタイルです。 |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | `git_branch`モジュールを無効にします。 |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -1036,15 +1036,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | moduleのフォーマットです。 |
|
||||
| `style` | `"bold green"` | モジュールのスタイルです。 |
|
||||
| `only_detached` | `true` | 切り離されたHEAD状態のときのみgit commit hashを表示します |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | `git_commit`モジュールを無効にします。 |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | moduleのフォーマットです。 |
|
||||
| `style` | `"bold green"` | モジュールのスタイルです。 |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | `git_commit`モジュールを無効にします。 |
|
||||
|
||||
### 変数
|
||||
|
||||
@ -1207,7 +1207,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | モジュールのスタイルです。 |
|
||||
@ -1544,7 +1544,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | モジュールのスタイルです。 |
|
||||
@ -1628,7 +1628,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | モジュールのスタイルです。 |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1668,7 +1668,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
@ -1744,18 +1744,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ---------- | ---------------------- |
|
||||
@ -1787,23 +1787,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | --------- | ---------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -1827,7 +1831,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
@ -1913,7 +1917,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | モジュールのスタイルです。 |
|
||||
@ -1950,7 +1954,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | モジュールのスタイルです。 |
|
||||
@ -1988,7 +1992,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | モジュールのスタイルです。 |
|
||||
@ -2035,13 +2039,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | moduleのフォーマットです。 |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | モジュールのスタイルです。 |
|
||||
| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します |
|
||||
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2064,7 +2068,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### 設定例
|
||||
|
||||
```toml
|
||||
@ -2168,7 +2171,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2179,7 +2181,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### オプション
|
||||
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 |
|
||||
@ -2209,7 +2210,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2241,6 +2241,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### 設定例
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2252,26 +2253,26 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | --- | -------------------------- |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | --- | ---------------------------- |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -2388,7 +2389,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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"` | モジュールのスタイルです。 |
|
||||
@ -2578,7 +2579,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"cyan bold"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
@ -2599,6 +2600,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ---------- | -------------------------------- | ------------------------------------------------------ |
|
||||
| `symbol` | | The symbol used before displaying the repository name. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `format` | `"vcsh [$symbol$repo]($style) "` | moduleのフォーマットです。 |
|
||||
| `disabled` | `false` | Disables the `vcsh` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ------------------------------------------- | -------------------------- |
|
||||
| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | `black bold dimmed` | オプション `style` の値をミラーする |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### 設定例
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l)
|
||||
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
|
||||
```
|
||||
|
||||
The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations.
|
||||
Starshipに搭載されている[Bashの実装](https://github.com/starship/starship/blob/master/src/init/starship.bash)は、[Command Duration モジュール](https://starship.rs/config/#command-duration)のような高度な機能を可能にするためと、プリインストールされたBashの設定との互換性を確保するために、若干複雑になっています。
|
||||
|
||||
`Starshipのプロンプト`で受け入れられるすべてのフラグのリストは、次のコマンドを取得できます。
|
||||
|
||||
@ -91,6 +91,6 @@ Starshipのアンインストールはインストールと同じぐらい簡単
|
||||
`curl | bash` スクリプトを使用してStarshipをインストールした場合は、以下のコマンドでバイナリを削除してください。
|
||||
|
||||
```sh
|
||||
# starshipバイナリを見つけて削除
|
||||
rm "$(which starship)"
|
||||
# Locate and delete the starship binary
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### パッケージマネージャー経由でインストール
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -6,9 +6,9 @@ Starship v0.45.0は、v1.0.0の準備として互換性の無い変更を含む
|
||||
|
||||
## `prompt_order`をルートレベルの`format`に置換
|
||||
|
||||
Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship.
|
||||
v0.45.0までは、`prompt_order` はStarshipによってレンダリングされる順序でモジュール名の配列を指定できるようになっていました。
|
||||
|
||||
Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves.
|
||||
Starship v0.45.0 では代わりに `format` を指定できるようになり、モジュール外でプロンプトをカスタマイズ可能になります。
|
||||
|
||||
**v0.45.0以前の設定例**
|
||||
|
||||
@ -52,11 +52,11 @@ format = """\
|
||||
"""
|
||||
```
|
||||
|
||||
## Module `prefix` and `suffix` have been replaced by `format`
|
||||
## モジュールの `prefix`と `suffix` を `format`に置換
|
||||
|
||||
Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered.
|
||||
v0.45.0以前では、モジュールのレンダリング方法をのスタイルを設定するために、 `prefix` や`suffix` を指定可能なモジュールがありました。
|
||||
|
||||
Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output.
|
||||
Starship v0.45.0 は代わりに `format` の値を受け付け、モジュールのレンダリング方法をさらにカスタマイズすることができます。 prefix とsuffix を定義する代わりに、コンテキストベースの変数については、モジュールの出力を表現するフォーマット文字列の中から変数を置き換えることができるようになりました。
|
||||
|
||||
**v0.45.0以前の設定例**
|
||||
|
||||
@ -109,7 +109,7 @@ v0.45.0 のリリースでは、ステータスコードがゼロでないとき
|
||||
error_symbol = "[✖](bold red)"
|
||||
```
|
||||
|
||||
*Note:* The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples.
|
||||
*注意:* `character` 要素は自動的にスペースを後ろに追加するため、他の `format` 文字列とは異なり、上記の例では特にスペースを追加していません。
|
||||
|
||||
#### Command Duration
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,11 +40,12 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### 패키지 매니저를 이용한 설치
|
||||
|
||||
[Homebrew](https://brew.sh/)를 통한 설치:
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,6 +40,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,6 +40,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,11 +40,12 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Instalar via Gerenciador de Pacotes
|
||||
|
||||
Com o [Homebrew](https://brew.sh/):
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
Para começar a configurar a starship, crie o seguinte arquivo: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml):
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Exemplo
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Indicador de bateria
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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"` | O estilo do módulo. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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"` | O estilo do módulo. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | O estilo do módulo. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variável | Exemplo | Descrição |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variável | Exemplo | Descrição |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | O estilo do módulo. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Padrão | Descrição |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | O estilo do módulo. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | O estilo do módulo. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | O estilo do módulo. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | O estilo do módulo. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variável | Exemplo | Descrição |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variável | Exemplo | Descrição |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variável | Exemplo | Descrição |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | O estilo do módulo. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | O estilo do módulo. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | O estilo do módulo. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | O estilo do módulo. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Exemplo
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Opções
|
||||
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
| Option | Padrão | Descrição |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variável | Exemplo | Descrição |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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"` | O estilo do módulo. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"cyan bold"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| ---------- | -------------------------------- | ------------------------------------------------------ |
|
||||
| `symbol` | | The symbol used before displaying the repository name. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. |
|
||||
| `disabled` | `false` | Disables the `vcsh` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variável | Exemplo | Descrição |
|
||||
| --------- | ------------------------------------------- | ------------------------------------ |
|
||||
| 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
|
||||
|
||||
### Exemplo
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Instalar via gerenciador de pacotes
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,6 +40,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,11 +40,12 @@ description: Starship - минимальная, быстрая и бесконе
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Установить через менеджер пакетов
|
||||
|
||||
С [Homebrew](https://brew.sh/):
|
||||
With [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
@ -133,4 +134,3 @@ description: Starship - минимальная, быстрая и бесконе
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ precmd_functions+=(set_win_title)
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
Чтобы начать конфигурацию Starship, создайте следующий файл: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
Вся конфигурация Starship выполняется в этом файле [TOML](https://github.com/toml-lang/toml):
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. |
|
||||
| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Отключение модуля `AWS`. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| -------------------- | --------------------------------- | ------------------------------------------------------- |
|
||||
| `full_symbol` | `""` | Символ, отображаемый при полной батарее. |
|
||||
| `charging_symbol` | `""` | Символ, показываемый при зарядке аккумулятора. |
|
||||
| `discharging_symbol` | `""` | Символ, показываемый при разрядке аккумулятора. |
|
||||
| `unknown_symbol` | `""` | Символ, отображаемый при неизвестном состоянии батареи. |
|
||||
| `empty_symbol` | `""` | Символ, отображаемый при пустом состоянии батареи. |
|
||||
| `full_symbol` | `" "` | Символ, отображаемый при полной батарее. |
|
||||
| `charging_symbol` | `" "` | Символ, показываемый при зарядке аккумулятора. |
|
||||
| `discharging_symbol` | `" "` | Символ, показываемый при разрядке аккумулятора. |
|
||||
| `unknown_symbol` | `" "` | Символ, отображаемый при неизвестном состоянии батареи. |
|
||||
| `empty_symbol` | `" "` | Символ, отображаемый при пустом состоянии батареи. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | Формат модуля. |
|
||||
| `display` | [ссылка](#battery-display) | Порог отображения и стиль для модуля. |
|
||||
| `disabled` | `false` | Отключает модуль `battery`. |
|
||||
|
||||
|
||||
### Пример
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Отображение батареи
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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"` | Стиль модуля. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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"` | Стиль модуля. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"•NET "` | Символ перед отображением текущей версии dotnet. |
|
||||
| `symbol` | `".NET "` | Символ перед отображением текущей версии dotnet. |
|
||||
| `heuristic` | `true` | Использовать быстрое определение версии, для сохранения скорости. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | Формат модуля. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | Стиль модуля. |
|
||||
| `truncation_length` | `2^63 - 1` | Отрезает ветку git до X графемов. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | Символ, используемый для обозначения усечения названия ветки. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Отключает модуль `git_branch`. |
|
||||
|
||||
### Переменные
|
||||
|
||||
| Переменная | Пример | Описание |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
| Переменная | Пример | Описание |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | Длина отображаемого хэша коммита git. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Формат модуля. |
|
||||
| `style` | `"bold green"` | Стиль модуля. |
|
||||
| `only_detached` | `true` | Показывать хэш коммита git, только находясь в состоянии отделённой HEAD |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Отключает модуль `git_commit`. |
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | Длина отображаемого хэша коммита git. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Формат модуля. |
|
||||
| `style` | `"bold green"` | Стиль модуля. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Отключает модуль `git_commit`. |
|
||||
|
||||
### Переменные
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | Стиль модуля. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | Стиль модуля. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | Символ, используемый перед закладкой hg или именем ветки репозитория в текущем каталоге. |
|
||||
| `style` | `"bold purple"` | Стиль модуля. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | Формат модуля. |
|
||||
| `truncation_length` | `2^63 - 1` | Обрезает имя ветки hg до X графемов |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | Символ, используемый для обозначения усечения названия ветки. |
|
||||
| `disabled` | `true` | Отключает модуль `hg_branch`. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Переменные
|
||||
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | Формат модуля. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | Стиль модуля. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"🐘 "` | Символ, используемый перед отображением версии PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | Стиль модуля. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | Стиль модуля. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | Формат модуля. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Формат модуля. |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | Стиль модуля. |
|
||||
| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python |
|
||||
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Пример
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Опции
|
||||
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Примеры
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | Формат модуля. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current SHLVL amount. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | Формат модуля. |
|
||||
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
|
||||
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `true` | Disables the `shlvl` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------- | ------ | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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"` | Стиль модуля. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"cyan bold"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ---------- | -------------------------------- | ------------------------------------------------------ |
|
||||
| `symbol` | | The symbol used before displaying the repository name. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `format` | `"vcsh [$symbol$repo]($style) "` | Формат модуля. |
|
||||
| `disabled` | `false` | Disables the `vcsh` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------- | ------------------------------------------- | ------------------------------------ |
|
||||
| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | `black bold dimmed` | Отражает значение параметра `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Пример
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Установить через менеджер пакетов
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
@ -40,6 +40,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
@ -133,4 +134,3 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ For example, if you want to display your current directory in your terminal tab
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
echo -ne "\033]0; $(basename $PWD) \007"
|
||||
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||
}
|
||||
starship_precmd_user_func="set_win_title"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
To get started configuring starship, create the following file: `~/.config/starship.toml`.
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
|
||||
```
|
||||
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
@ -180,6 +180,7 @@ $hostname\
|
||||
$shlvl\
|
||||
$kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -248,7 +249,7 @@ When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -310,25 +311,24 @@ The `battery` module shows how charged the device's battery is and its current c
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | --------------------------------- | --------------------------------------------------- |
|
||||
| `full_symbol` | `""` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `""` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `""` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `""` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `""` | The symbol shown when the battery state is empty. |
|
||||
| `full_symbol` | `" "` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `" "` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `" "` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `" "` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `" "` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
| `disabled` | `false` | Disables the `battery` module. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[battery]
|
||||
full_symbol = "🔋"
|
||||
charging_symbol = "⚡️"
|
||||
discharging_symbol = "💀"
|
||||
full_symbol = "🔋 "
|
||||
charging_symbol = "⚡️ "
|
||||
discharging_symbol = "💀 "
|
||||
```
|
||||
|
||||
### Battery Display
|
||||
@ -438,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th
|
||||
| ------------------- | -------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[]` | Which extensions 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. |
|
||||
@ -595,7 +595,7 @@ The `dart` module shows the currently installed version of Dart. By default the
|
||||
| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -745,7 +745,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "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. |
|
||||
@ -1001,20 +1001,20 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| 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
|
||||
|
||||
@ -1035,15 +1035,15 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1206,7 +1206,7 @@ The `golang` module shows the currently installed version of Golang. By default
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold cyan"` | The style for the module. |
|
||||
@ -1543,7 +1543,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold blue"` | The style for the module. |
|
||||
@ -1627,7 +1627,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||
| `style` | `"bold purple"` | The style for the module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
@ -1667,7 +1667,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
@ -1743,18 +1743,18 @@ The `nodejs` module shows the currently installed version of NodeJS. By default
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `bold red` | The style for the module when an engines property in `package.json` does not match the NodeJS version. |
|
||||
|
||||
### Variables
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ------------------------------------ |
|
||||
@ -1786,23 +1786,27 @@ The `ocaml` module shows the currently installed version of OCaml. By default th
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `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. |
|
||||
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `ocaml` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ------------ | ----------------------------------------------------------------- |
|
||||
| version | `v4.10.0` | The version of `ocaml` |
|
||||
| switch_name | `my-project` | The active OPAM switch |
|
||||
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
|
||||
| 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
|
||||
|
||||
@ -1826,7 +1830,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
|
||||
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `OpenStack` module. |
|
||||
| `disabled` | `false` | Disables the `openstack` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -1912,7 +1916,7 @@ The `perl` module shows the currently installed version of Perl. By default the
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
@ -1949,7 +1953,7 @@ The `php` module shows the currently installed version of PHP. By default the mo
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
| `style` | `"147 bold"` | The style for the module. |
|
||||
@ -1987,7 +1991,7 @@ The `purescript` module shows the currently installed version of PureScript vers
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold white"` | The style for the module. |
|
||||
@ -2034,13 +2038,13 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | The format for the module. |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `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 |
|
||||
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
|
||||
| `detect_extensions` | `[".py"]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
@ -2063,7 +2067,6 @@ The default values and order for `python_binary` was chosen to first identify th
|
||||
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `"venv"` | The current `virtualenv` name |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
@ -2167,7 +2170,6 @@ By default the `rust` module shows the currently installed version of Rust. The
|
||||
format = "via [⚙️ $version](red bold)"
|
||||
```
|
||||
|
||||
|
||||
## Scala
|
||||
|
||||
The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:
|
||||
@ -2178,7 +2180,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
|
||||
### Options
|
||||
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
@ -2208,7 +2209,6 @@ The `scala` module shows the currently installed version of Scala. By default th
|
||||
symbol = "🌟 "
|
||||
```
|
||||
|
||||
|
||||
## Shell
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
@ -2240,6 +2240,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
|
||||
| indicator | | Mirrors the value of `indicator` for currently used shell. |
|
||||
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@ -2251,24 +2252,24 @@ disabled = false
|
||||
|
||||
## SHLVL
|
||||
|
||||
The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ----------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ----------- | ---------------------------- | ------------------------------------------------------------- |
|
||||
| `threshold` | `2` | Display threshold. |
|
||||
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
|
||||
| `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. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| shlvl | `3` | The current value of SHLVL |
|
||||
| shlvl | `3` | The current value of `SHLVL` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
@ -2387,7 +2388,7 @@ By default the `swift` module shows the currently installed version of Swift. Th
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
|
||||
| `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. |
|
||||
@ -2577,7 +2578,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
| `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. |
|
||||
| `disabled` | `false` | Disables the `Vagrant` module. |
|
||||
| `disabled` | `false` | Disables the `vagrant` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2598,6 +2599,38 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| 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. |
|
||||
| `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` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcsh]
|
||||
format = "[🆅 $repo](bold blue) "
|
||||
```
|
||||
|
||||
## Zig
|
||||
|
||||
By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
|
||||
|
||||
@ -92,5 +92,5 @@ If Starship was installed using the `curl | bash` script, the following command
|
||||
|
||||
```sh
|
||||
# Locate and delete the starship binary
|
||||
rm "$(which starship)"
|
||||
bash -c 'rm "$(which starship)"'
|
||||
```
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -98,7 +98,7 @@
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -106,7 +106,7 @@
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
@ -160,6 +160,7 @@
|
||||
```sh
|
||||
curl -fsSL https://starship.rs/install.sh | bash
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
@ -45,7 +45,7 @@ curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](home-manager)
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ symbol = " "
|
||||
[directory]
|
||||
read_only = " "
|
||||
|
||||
[docker]
|
||||
[docker_context]
|
||||
symbol = " "
|
||||
|
||||
[elixir]
|
||||
@ -42,9 +42,6 @@ symbol = " "
|
||||
[golang]
|
||||
symbol = " "
|
||||
|
||||
[haskell]
|
||||
symbol = " "
|
||||
|
||||
[hg_branch]
|
||||
symbol = " "
|
||||
|
||||
@ -63,9 +60,6 @@ symbol = " "
|
||||
[nix_shell]
|
||||
symbol = " "
|
||||
|
||||
[nodejs]
|
||||
symbol = " "
|
||||
|
||||
[package]
|
||||
symbol = " "
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user