extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-11-29 19:53:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(i18n): New Crowdin updates (#2275)

Browse Source 
* New translations README.md (French)

* New translations README.md (Chinese Traditional)

* New translations README.md (Russian)

* New translations README.md (Turkish)

* New translations README.md (Chinese Simplified)

* New translations README.md (Portuguese)

* New translations README.md (Vietnamese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Sorani (Kurdish))

* 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 (Spanish)

* New translations README.md (Spanish)

* New translations README.md (Vietnamese)

* New translations README.md (Vietnamese)

* New translations README.md (Vietnamese)

* 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 (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 (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 (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 (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 (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 (Italian)

* New translations README.md (Italian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Japanese)

* New translations README.md (Italian)

* New translations README.md (German)

* New translations README.md (Arabic)

* New translations README.md (Turkish)

* New translations README.md (Russian)

* New translations README.md (Dutch)

* New translations README.md (Portuguese)

* New translations README.md (Polish)

* 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 (Vietnamese)

* New translations README.md (Chinese Traditional)

* 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 (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 (Italian)

* New translations README.md (French)

* New translations README.md (Spanish)

* New translations README.md (Arabic)

* New translations README.md (German)

* 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 (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 (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 (Vietnamese)

* New translations README.md (Vietnamese)

* New translations README.md (Vietnamese)

* New translations README.md (Vietnamese)

* 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 (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 2021-02-21 14:13:18 -05:00 committed by GitHub
parent 0083e28827
commit 7c02433085
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
54 changed files with 6175 additions and 3829 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

540
docs/ar-SA/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

2
docs/ar-SA/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" /></a> alt="Chat on Discord" /></a>

10
docs/ar-SA/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisites
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

540
docs/ckb-IR/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

2
docs/ckb-IR/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" /></a> alt="Chat on Discord" /></a>

10
docs/ckb-IR/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisites
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

612
docs/de-DE/config/README.md
View File

File diff suppressed because it is too large Load Diff

2
docs/de-DE/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Paket-Status" /></a alt="Paket-Status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat auf Discord" /></a> alt="Chat auf Discord" /></a>

10
docs/de-DE/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Voraussetzungen
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

786
docs/es-ES/config/README.md
View File

File diff suppressed because it is too large Load Diff

2
docs/es-ES/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Estado de empaquetado" /></a alt="Estado de empaquetado" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat en Discord" /></a> alt="Chat en Discord" /></a>

14
docs/es-ES/installing/README.md
View File

@ -8,10 +8,20 @@ Para instalar Starship, necesitas hacer dos cosas:
Para la mayoría de los usuarios, las instrucciones en [la página principal](/guide/#🚀-installation) funcionarán genial. Sin embargo, para algunas plataformas más especializadas, se necesitan diferentes instrucciones. Para la mayoría de los usuarios, las instrucciones en [la página principal](/guide/#🚀-installation) funcionarán genial. Sin embargo, para algunas plataformas más especializadas, se necesitan diferentes instrucciones.
Hay tantas plataformas ahí fuera que no cabían en el README.md principal, así que aquí están algunas instrucciones de instalación para otras plataformas de la comunidad. ¿No está usted aquí? ¡Por favor, añádelo aquí si lo encuentras! Hay tantas plataformas ahí fuera que no cabían en el README.md principal, así que aquí están algunas instrucciones de instalación para otras plataformas de la comunidad. ¿No está usted aquí? ¡Por favor, añádelo aquí si lo encuentras!
## [termux](https://termux.com)
### Prerequisitos
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)
### Obtener el binario ### Getting the Binary
#### Imperativamente #### Imperativamente
@ -35,7 +45,7 @@ Añade `pkgs.starship` a `environment.packages` en tu `configuration.nix`, luego
sudo nixos-rebuild switch sudo nixos-rebuild switch
``` ```
### Modificando guiones Init ### Modifying Init Scripts
#### Con Nix y home-manager, usando zsh: #### Con Nix y home-manager, usando zsh:

584
docs/fr-FR/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # Le segment "success_symbol" est mis co
disabled = true disabled = true
``` ```
Vous pouvez changer l'emplacement par défaut du fichier `starship.toml` avec la variable d'environnement `STARSHIP_CONFIG` : You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante à votre `$PROFILE`: De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante à votre `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Journalisation ### Journalisation
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
Le module `cmake` affiche la version actuellement installée de CMake si l'une des conditions suivantes est remplie : The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- Le répertoire actuel contient un fichier `CMakeLists.txt` - Le répertoire actuel contient un fichier `CMakeLists.txt`
- Le répertoire actuel contient un fichier ` CMakeCache.txt` - Le répertoire actuel contient un fichier ` CMakeCache.txt`
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | --------------------------------------------- | | ------------------- | -------------------------------------- | --------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"喝 "` | Le symbole utilisé avant la version de cmake. | | `symbol` | `"喝 "` | Le symbole utilisé avant la version de cmake. |
| `style` | `"bold blue"` | Le style du module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Désactive le module `cmake`. | | `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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
Le module `crystal` affiche la version actuellement installée de Crystal. Le module est affiché si l'une des ces conditions est remplie : Le module `crystal` affiche la version actuellement installée de Crystal. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `shard.yml` - Le répertoire courant contient un fichier `shard.yml`
- Le répertoire courant contient un fichier `.cr` - Le répertoire courant contient un fichier `.cr`
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ---------------------------------------------------------- | | ------------------- | ------------------------------------ | ---------------------------------------------------------- |
| `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. | | `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Désactive le module `crystal`. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
Le module `dart` affiche la version courante installée de Dart. Le module est affiché si l'une des ces conditions est remplie : Le module `dart` affiche la version courante installée de Dart. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `.dart` - Le répertoire courant contient un fichier `.dart`
- Le répertoire courant contient un répertoire `.dart_tool` - Le répertoire courant contient un répertoire `.dart_tool`
- Le répertoire courant contient un fichier `pubspec.yaml` ou `pubspec.lock` - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart | | `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart |
| `style` | `"bold blue"` | Le style du module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Désactive le module `dart`. | | `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. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo
<details> <details>
<summary>Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire.</summary> <summary>Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire.</summary>
| Options avancées | Défaut | Description | | Options avancées | Défaut | Description |
| --------------------------- | ------ | ---------------------------------------------------------------------------------------- | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | Table de substitutions à faire au chemin. | | `substitutions` | | Table de substitutions à faire au chemin. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | Format du module. | | `format` | `"via [$symbol$context]($style) "` | Format du module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | Le style du module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Affiché quand il y a un `docker-compose.yml`, `docker-compose.yaml`, ou un `Dockerfile` dans le dossier actuel. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Désactive le module `docker_context`. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | Le style du module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Format du module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | Le style du module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Désactive le module `dotnet`. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | Le style du module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
Le module `elixir` affiche la version actuellement installé d'Elixir et Erlang/OTP. Le module est affiché si l'une des ces conditions est remplie : Le module `elixir` affiche la version actuellement installé d'Elixir et Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `mix.exs`. - Le répertoire courant contient un fichier `mix.exs`.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | Le style du module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | Le style du module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. Le module est affiché si l'une des ces conditions est remplie : The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `elm.json` - Le répertoire courant contient un fichier `elm.json`
- Le répertoire courant contient un fichier `elm-package.json` - Le répertoire courant contient un fichier `elm-package.json`
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. Le module est aff
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | Le style du module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | Le style du module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. Le module est affiché si l'une des ces conditions est remplie : The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `rebar.config`. - Le répertoire courant contient un fichier `rebar.config`.
- Le répertoire courant contient un fichier `erlang.mk`. - Le répertoire courant contient un fichier `erlang.mk`.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. Le module est affiché si l'une des ces conditions est remplie : The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `go.mod` - Le répertoire courant contient un fichier `go.mod`
- Le répertoire courant contient un fichier `go.sum` - Le répertoire courant contient un fichier `go.sum`
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. Le module e
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | Le style du module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. Le module est affiché si l'une des ces conditions est remplie : The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `helmfile.yaml` - Le répertoire courant contient un fichier `helmfile.yaml`
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | Le style du module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | Le style du module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. Le module est affiché si l'une des ces conditions est remplie : The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. | | `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | Le style du module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | Le style du module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. Le module est affiché si l'une des ces conditions est remplie : The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. Le module est
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | Le style du module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | Le style du module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. Le module est affiché si l'une des ces conditions est remplie : The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | Le style du module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | Le style du module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. Le module est affiché si l'une des ces conditions est remplie : The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. Le module est aff
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | Le style du module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | Le style du module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. Le module est affiché si l'une des ces conditions est remplie : The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `nim.cfg` - Le répertoire courant contient un fichier `nim.cfg`
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. Le module est aff
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module | | `format` | `"via [$symbol($version )]($style)"` | Format du module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | Le style du module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. Le module est affiché si l'une des ces conditions est remplie : The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `package.json` - Le répertoire courant contient un fichier `package.json`
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. Le module e
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | Le style du module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. Le module est affiché si l'une des ces conditions est remplie : The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. Le module est
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | Le style du module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. Le module est affiché si l'une des ces conditions est remplie : The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. Le module est a
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | Le style du module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. Le module est affiché si l'une des ces conditions est remplie : The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `composer.json` - Le répertoire courant contient un fichier `composer.json`
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | Le style du module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
Le module `purescript` affiche la version courante de Purescript installée. Le module est affiché si l'une des ces conditions est remplie : Le module `purescript` affiche la version courante de Purescript installée. By default the module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `spago.dhall` - Le répertoire courant contient un fichier `spago.dhall`
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. | | `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. |
| `style` | `"bold white"` | Le style du module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Désactive le module `purescript`. | | `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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
Le module est affiché si l'une des ces conditions est remplie : By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- Le répertoire courant contient un fichier `requirements.txt`
- Le répertoire courant contient un fichier `pyproject.toml`
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- Le répertoire courant contient un fichier `tox.ini`
- Le répertoire courant contient un fichier `setup.py`
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Défaut | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | Le style du module. | | `style` | `"yellow bold"` | Le style du module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. Le module est affiché si l'une des ces conditions est remplie : By default the `ruby` module shows the currently installed version of Ruby. Le module est affiché si l'une des ces conditions est remplie :
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. Le module est a
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold green"` | Le style du module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold green"` | Le style du module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. Le module est affiché si l'une des ces conditions est remplie : By default the `rust` module shows the currently installed version of Rust. Le module est affiché si l'une des ces conditions est remplie :
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold green"` | Le style du module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold green"` | Le style du module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. Le module est a
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
:::
### Options
| Option | Défaut | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | Format du module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Défaut | Description |
| --------- | ------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Exemples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. Le module est affiché si l'une des ces conditions est remplie : By default the `swift` module shows the currently installed version of Swift. Le module est affiché si l'une des ces conditions est remplie :
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Le style du module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
Le module est affiché si l'une des ces conditions est remplie : By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | Le style du module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | Le style du module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2298,7 +2420,7 @@ format = "[🏎💨 $workspace]($style) "
## Temps ## Temps
Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -2308,23 +2430,23 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Activer le format 12h | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | Le style utilisé par le module | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Range from -24 &lt; x &lt; 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Désactiver le module `time`. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Sinon, il est défini comme `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ---------- | ------------------------------------- | | --------- | ---------- | ------------------------------------- |
| temps | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style \* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
@ -2342,9 +2464,9 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## Nom d'utilisateur ## Username
Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une des ces conditions est remplie : The `username` module shows active user's username. Le module est affiché si l'une des ces conditions est remplie :
- L'utilisateur courant est root - L'utilisateur courant est root
- L'utilisateur courant est différent de celui connecté - L'utilisateur courant est différent de celui connecté
@ -2359,13 +2481,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------- | ----------------------- | ------------------------------------------------ | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root. | | `style_root` | `"bold green"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | Format du module. | | `format` | `"[$user]($style) in "` | Format du module. |
| `show_always` | `false` | Toujours afficher le module `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Désactiver le module `username`. | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. Le module est affiché si l'une des ces conditions est remplie : The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | Le style du module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `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. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. Le module est affiché si l'une des ces conditions est remplie : By default the the `zig` module shows the currently installed version of Zig. Le module est affiché si l'une des ces conditions est remplie :
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables
@ -2512,7 +2640,7 @@ The order in which custom modules are shown can be individually set by including
#### Commandes shell personnalisées #### Commandes shell personnalisées
`shell` accepte une liste de chaînes non vide, où: `shell` accepts a non-empty list of strings, where:
- La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande. - La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande.
- Other following arguments are passed to the shell. - Other following arguments are passed to the shell.

2
docs/fr-FR/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Statut du package" /></a alt="Statut du package" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Discuter sur Discord" /></a> alt="Discuter sur Discord" /></a>

14
docs/fr-FR/installing/README.md
View File

@ -8,10 +8,20 @@ Pour installer starship, vous devez faire deux choses:
Pour la plupart des utilisateurs, les instructions sur [la page principale](/guide/#🚀-installation) fonctionneront bien. Cependant, pour certaines plateformes plus spécialisées, des instructions différentes sont nécessaires. Pour la plupart des utilisateurs, les instructions sur [la page principale](/guide/#🚀-installation) fonctionneront bien. Cependant, pour certaines plateformes plus spécialisées, des instructions différentes sont nécessaires.
Il y a tellement de plates-formes, qu'il aurait été déraisonnable de les faire apparaître dans le README principal, voici donc quelques instructions d'installation supplémentaires pour celles-ci, écrient par la commaunauté. La vôtre n'est-elle pas là ? S'il vous plaît, ajoutez-la ici pour les suivants ! Il y a tellement de plates-formes, qu'il aurait été déraisonnable de les faire apparaître dans le README principal, voici donc quelques instructions d'installation supplémentaires pour celles-ci, écrient par la commaunauté. La vôtre n'est-elle pas là ? S'il vous plaît, ajoutez-la ici pour les suivants !
## [termux](https://termux.com)
### Pré-requis
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)
### Obtention du binaire ### Getting the Binary
#### Impératif #### Impératif
@ -35,7 +45,7 @@ Ajoutez `pkgs.starship` à `environment.packages` dans votre `configuration.nix`
sudo nixos-rebuild switch sudo nixos-rebuild switch
``` ```
### Modification des scripts d'initialisation ### Modifying Init Scripts
#### Avec Nix et home manager, en utilisant zsh : #### Avec Nix et home manager, en utilisant zsh :

2
docs/it-IT/README.md
View File

@ -115,7 +115,7 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per
::: warning Only elvish v0.15 or higher is supported. ::: ::: warning Only elvish v0.15 or higher is supported. :::
Add the following to the end of `~/.elvish/rc.elv`: Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`:
```sh ```sh
# ~/.elvish/rc.elv # ~/.elvish/rc.elv

554
docs/it-IT/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1688,13 +1734,16 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `style` | `"bold green"` | The style for the module. | | `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nodejs` module. | | `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
| `not_capable_style` | `bold red` | Lo stile per il modulo quando una proprietà chiave in Packages.json non corrisponde alla versione NodeJS. | | `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. |
###  Variables ###  Variables
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

8
docs/it-IT/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Stato del pacchetto" /></a alt="Stato del pacchetto" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat su Discord" /></a> alt="Chat su Discord" /></a>
@ -132,7 +132,7 @@
### Inizia ### Inizia
**Note**: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the [extra platform instructions](https://starship.rs/installing/). **Nota**: a causa della proliferazione di piattaforme diverse, un sottoinsieme di piattaforme supportate sono mostrate di seguito. Non riesci a vedere la tua? Dai un'occhiata alle [istruzioni aggiuntive della piattaforma](https://starship.rs/installing/).
1. Installa il binario **starship**: 1. Installa il binario **starship**:
@ -150,7 +150,7 @@
#### Installa via Package Manager #### Installa via Package Manager
##### Example: [Homebrew](https://brew.sh/): ##### Esempio: [Homebrew](https://brew.sh/):
```sh ```sh
brew install starship brew install starship
@ -221,7 +221,7 @@
#### Elvish #### Elvish
**Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: **Attenzione** È supportato solo elvish v0.15 o superiore. Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`:
```sh ```sh
# ~/.elvish/rc.elv # ~/.elvish/rc.elv

10
docs/it-IT/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisiti
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

592
docs/ja-JP/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # 「success_symbol」セグメント
disabled = true disabled = true
``` ```
`STARSHIP_CONFIG` 環境変数を使用して、デフォルトの`starship.toml` ファイルの場所を変更できます。 You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。 PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### ロギング ### ロギング
@ -228,6 +228,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -424,19 +425,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` module. | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `cmake` module. |
### 変数 ### 変数
@ -539,19 +543,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
`crystal`モジュールには、現在インストールされているCrystalのバージョンが表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。 `crystal`モジュールには、現在インストールされているCrystalのバージョンが表示されます。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`shard.yml`ファイルが含まれている - カレントディレクトリに`shard.yml`ファイルが含まれている
- カレントディレクトリに`.cr`の拡張子のファイルが含まれている - カレントディレクトリに`.cr`の拡張子のファイルが含まれている
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ------------------------------ | | ------------------- | ------------------------------------ | -------------------------------------------- |
| `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 | | `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `style` | `"bold red"` | モジュールのスタイルです。 |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | `crystal`モジュールを無効にします。 | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `disabled` | `false` | Disables the `crystal` module. |
### 変数 ### 変数
@ -574,20 +581,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- カレントディレクトリに`pubspec.yaml`, もしくは`pubspec.lock`ファイルが含まれている - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `dart` module. |
### 変数 ### 変数
@ -633,11 +643,11 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
<details> <details>
<summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary> <summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary>
| Advanced Option | デフォルト | 説明 | | Advanced Option | デフォルト | 説明 |
| --------------------------- | ------ | ------------------------------------------------ | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 | | `fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 |
| `use_logical_path` | `true` | OSからのパスの代わりに、シェル(`PWD`) によって提供される論理パスを表示します。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -676,13 +686,16 @@ truncation_symbol = "…/"
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | moduleのフォーマットです。 | | `format` | `"via [$symbol$context]($style) "` | moduleのフォーマットです。 |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | モジュールのスタイルです。 | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | `docker_context`モジュールを無効にします。 | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `docker_context` module. |
### 変数 ### 変数
@ -707,7 +720,7 @@ format = "via [🐋 $context](blue bold)"
`dotnet` モジュールはカレントディレクトリに関係する.NET Core SDKのバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。 `dotnet` モジュールはカレントディレクトリに関係する.NET Core SDKのバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -727,13 +740,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ----------- | ----------------------------------------- | ------------------------------------ | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | moduleのフォーマットです。 | | `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `•NET "` | dotnetのバージョンを表示する前に使用される記号です。 | | `symbol` | `•NET "` | dotnetのバージョンを表示する前に使用される記号です。 |
| `heuristic` | `true` | より高速なバージョン検出を使用して、starshipの動作を維持します。 | | `heuristic` | `true` | より高速なバージョン検出を使用して、starshipの動作を維持します。 |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | `dotnet`モジュールを無効にします。 | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `dotnet` module. |
### 変数 ### 変数
@ -759,18 +775,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`mix.exs`ファイルが含まれている. - カレントディレクトリに`mix.exs`ファイルが含まれている.
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | モジュールのスタイルです。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | モジュールのスタイルです。 |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### 変数 ### 変数
@ -794,7 +813,7 @@ symbol = "🔮 "
## Elm ## Elm
`elm`モジュールは、現在インストールされているElmのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 `elm`モジュールは、現在インストールされているElmのバージョンを示します。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`elm.json`ファイルが含まれている - カレントディレクトリに`elm.json`ファイルが含まれている
- カレントディレクトリに`elm-package.json`ファイルが含まれている - カレントディレクトリに`elm-package.json`ファイルが含まれている
@ -804,12 +823,15 @@ symbol = "🔮 "
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | モジュールのスタイルです。 | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | `elm`モジュールを無効にします。 | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `elm` module. |
### 変数 ### 変数
@ -869,19 +891,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`rebar.config`ファイルが含まれている. - カレントディレクトリに`rebar.config`ファイルが含まれている.
- カレントディレクトリに`erlang.mk`ファイルが含まれている. - カレントディレクトリに`erlang.mk`ファイルが含まれている.
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `style` | `"bold red"` | モジュールのスタイルです。 |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `disabled` | `false` | Disables the `erlang` module. |
### 変数 ### 変数
@ -1162,7 +1187,7 @@ behind = "⇣${count}"
## Golang ## Golang
`golang`モジュールは、現在インストールされているGolangのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 `golang`モジュールは、現在インストールされているGolangのバージョンを示します。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`go.mod`ファイルが含まれている - カレントディレクトリに`go.mod`ファイルが含まれている
- カレントディレクトリに`go.sum`ファイルが含まれている - カレントディレクトリに`go.sum`ファイルが含まれている
@ -1175,12 +1200,15 @@ behind = "⇣${count}"
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | モジュールのスタイルです。 | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | `golang`モジュールを無効にします。 | | `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"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `golang` module. |
### 変数 ### 変数
@ -1203,19 +1231,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`helmfile.yaml`ファイルが含まれている - カレントディレクトリに`helmfile.yaml`ファイルが含まれている
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | モジュールのスタイルです。 | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `helm` module. |
### 変数 ### 変数
@ -1273,19 +1304,22 @@ disabled = false
## Java ## Java
`java`モジュールは、現在インストールされているJavaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 `java`モジュールは、現在インストールされているJavaのバージョンを示します。 By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | モジュールのスタイルです。 | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | `java`モジュールを無効にします。 | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `java` module. |
### 変数 ### 変数
@ -1342,7 +1376,7 @@ threshold = 4
## Julia ## Julia
`julia`モジュールは、現在インストールされているJuliaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 `julia`モジュールは、現在インストールされているJuliaのバージョンを示します。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`Project.toml`ファイルが含まれている - カレントディレクトリに`Project.toml`ファイルが含まれている
- カレントディレクトリに`Manifest.toml`ファイルが含まれている - カレントディレクトリに`Manifest.toml`ファイルが含まれている
@ -1350,12 +1384,15 @@ threshold = 4
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | モジュールのスタイルです。 | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | `julia`モジュールを無効にします。 | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `julia` module. |
### 変数 ### 変数
@ -1378,19 +1415,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### 変数 ### 変数
@ -1483,7 +1523,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1491,13 +1531,16 @@ The `lua` module shows the currently installed version of Lua. 次の条件の
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### 変数 ### 変数
@ -1604,7 +1647,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`nim.cfg`ファイルが含まれている - カレントディレクトリに`nim.cfg`ファイルが含まれている
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1613,12 +1656,15 @@ The `nim` module shows the currently installed version of Nim. 次の条件の
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` module. | | `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `nim` module. |
### 変数 ### 変数
@ -1680,7 +1726,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
`nodejs`モジュールは、現在インストールされているNodeJSのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 `nodejs`モジュールは、現在インストールされているNodeJSのバージョンを示します。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`package.json`ファイルが含まれている - カレントディレクトリに`package.json`ファイルが含まれている
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1694,8 +1740,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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"` | モジュールのスタイルです。 | | `style` | `"bold green"` | モジュールのスタイルです。 |
| `disabled` | `false` | `nodejs`モジュールを無効にします。 | | `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
###  Variables ###  Variables
@ -1719,7 +1768,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1730,12 +1779,15 @@ The `ocaml` module shows the currently installed version of OCaml. 次の条件
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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. |
### 変数 ### 変数
@ -1839,7 +1891,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1849,12 +1901,15 @@ The `perl` module shows the currently installed version of Perl. 次の条件の
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | モジュールのスタイルです。 | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `perl` module. |
### 変数 ### 変数
@ -1875,20 +1930,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
`php`モジュールは、現在インストールされているPHPのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 `php`モジュールは、現在インストールされているPHPのバージョンを示します。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`composer.json`ファイルが含まれている - カレントディレクトリに`composer.json`ファイルが含まれている
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- カレントディレクトリに`.php`の拡張子のファイルが含まれている - The current directory contains a `.php` extension
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | -------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 | | `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 |
| `style` | `"147 bold"` | モジュールのスタイルです。 | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | `php`モジュールを無効にします。 | | `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"147 bold"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `php` module. |
### 変数 ### 変数
@ -1911,19 +1969,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`spago.dhall`ファイルが含まれている - カレントディレクトリに`spago.dhall`ファイルが含まれている
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | モジュールのスタイルです。 | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold white"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `purescript` module. |
### 変数 ### 変数
@ -1950,30 +2011,32 @@ format = "via [$symbol$version](bold white)"
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
次の条件のいずれかが満たされると、モジュールが表示されます。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`.python-version`ファイルが含まれている - カレントディレクトリに`.python-version`ファイルが含まれている
- カレントディレクトリに`requirements.txt`ファイルが含まれている - The current directory contains a `Pipfile` file
- カレントディレクトリに`pyproject.toml`ファイルが含まれている
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- カレントディレクトリに`Pipfile`ファイルが含まれている
- カレントディレクトリに`tox.ini`ファイルが含まれている
- カレントディレクトリに`setup.py`ファイルが含まれている
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- 仮想環境がアクティブである - 仮想環境がアクティブである
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| -------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | モジュールのスタイルです。 | | `style` | `"yellow bold"` | モジュールのスタイルです。 |
| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | | `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | `python`モジュールを無効にします。 | | `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. |
::: tip ::: tip
@ -2012,9 +2075,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
`ruby`モジュールは、現在インストールされているRubyのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 By default the `ruby` module shows the currently installed version of Ruby. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`Gemfile`ファイルが含まれている - カレントディレクトリに`Gemfile`ファイルが含まれている
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2022,12 +2093,15 @@ python_binary = "python3"
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | `ruby`モジュールを無効にします。 | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `ruby` module. |
### 変数 ### 変数
@ -2050,19 +2124,22 @@ symbol = "🔺 "
## Rust ## Rust
`rust`モジュールには、現在インストールされているRustのバージョンが表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。 By default the `rust` module shows the currently installed version of Rust. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`Cargo.toml`ファイルが含まれている - カレントディレクトリに`Cargo.toml`ファイルが含まれている
- カレントディレクトリに`.rs`の拡張子のファイルが含まれている - カレントディレクトリに`.rs`の拡張子のファイルが含まれている
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | `rust`モジュールを無効にします。 | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `rust` module. |
### 変数 ### 変数
@ -2083,6 +2160,45 @@ symbol = "🔺 "
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。
:::
### オプション
| オプション | デフォルト | 説明 |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | moduleのフォーマットです。 |
| `disabled` | `true` | Disables the `shell` module. |
### 変数
| 変数 | デフォルト | 説明 |
| --------- | ----- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### 設定例
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2210,19 +2326,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. 次の条件のいずれかが満たされると、モジュールが表示されます。 By default the `swift` module shows the currently installed version of Swift. 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | モジュールのスタイルです。 | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 202"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `swift` module. |
### 変数 ### 変数
@ -2245,7 +2364,7 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
`terraform`モジュールには、現在選択されているterraformワークスペースとバージョンが表示されます。 The `terraform` module shows the currently selected terraform workspace and version.
::: tip ::: tip
@ -2253,19 +2372,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
次の条件のいずれかが満たされると、モジュールが表示されます。 By default the module will be shown if any of the following conditions are met:
- カレントディレクトリに`.terraform`フォルダが含まれている - カレントディレクトリに`.terraform`フォルダが含まれている
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | モジュールのスタイルです。 | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | `terraform`モジュールを無効にします。 | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `terraform` module. |
### 変数 ### 変数
@ -2300,7 +2422,7 @@ format = "[🏎💨 $workspace]($style) "
## Time ## Time
`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -2310,23 +2432,23 @@ format = "[🏎💨 $workspace]($style) "
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | 使用するUTCオフセットを設定します。 Range from -24 &lt; x &lt; 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。 | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | `time`モジュールを無効にします。 | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. それ以外の場合、デフォルトは`"%T"`です。 Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------- | ---------------------- | | --------- | ---------- | ---------------------- |
| 時刻 | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
\*: この変数はスタイル文字列の一部としてのみ使用できます \*: この変数はスタイル文字列の一部としてのみ使用できます
@ -2344,9 +2466,9 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## ユーザー名 ## Username
`username`モジュールには、アクティブなユーザーのユーザー名が表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。 The `username` module shows active user's username. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントユーザーがroot - カレントユーザーがroot
- カレントユーザーが、ログインしているユーザーとは異なる - カレントユーザーが、ログインしているユーザーとは異なる
@ -2361,13 +2483,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------- | ----------------------- | ------------------------- | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | ユーザーがrootのときに使用されるスタイルです。 | | `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | moduleのフォーマットです。 | | `format` | `"[$user]($style) in "` | moduleのフォーマットです。 |
| `show_always` | `false` | `username` モジュールを常に表示します。 | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | `username` モジュールを無効にします。 | | `disabled` | `false` | Disables the `username` module. |
### 変数 ### 変数
@ -2391,18 +2513,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. 次の条件のいずれかが満たされると、モジュールが表示されます。 The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | モジュールのスタイルです。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `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. |
### 変数 ### 変数
@ -2425,18 +2550,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. 次の条件のいずれかが満たされると、モジュールが表示されます。 By default the the `zig` module shows the currently installed version of Zig. 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### 変数 ### 変数
@ -2492,8 +2620,8 @@ The order in which custom modules are shown can be individually set by including
| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [この表の下を参照してください](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `説明` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

2
docs/ja-JP/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" /></a> alt="Chat on Discord" /></a>

10
docs/ja-JP/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### 必要なもの
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

540
docs/ko-KR/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

2
docs/ko-KR/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="패키징 상태" /></a alt="패키징 상태" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="디스코드에 채팅을 하세요" /></a> alt="디스코드에 채팅을 하세요" /></a>

10
docs/ko-KR/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisites
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

540
docs/nl-NL/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

2
docs/nl-NL/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" /></a> alt="Chat on Discord" /></a>

10
docs/nl-NL/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisites
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

540
docs/pl-PL/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

2
docs/pl-PL/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" /></a> alt="Chat on Discord" /></a>

10
docs/pl-PL/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisites
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

542
docs/pt-BR/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
Você pode alterar o caminho padrão do arquivo `starship.toml` com a variável de ambiente `STARSHIP_CONFIG`: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
No PowerShell (Windows) você pode adicionar a seguinte linha no seu `$PROFILE`: No PowerShell (Windows) você pode adicionar a seguinte linha no seu `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | O estilo do módulo. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | O estilo do módulo. | | `style` | `"bold red"` | O estilo do módulo. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | O estilo do módulo. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` 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. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Padrão | Descrição | | Advanced Option | Padrão | Descrição |
| --------------------------- | ------ | ---------------------------------------------------------------------------------------- | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | O estilo do módulo. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | O estilo do módulo. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | O estilo do módulo. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | O estilo do módulo. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | O estilo do módulo. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | O estilo do módulo. | | `style` | `"bold red"` | O estilo do módulo. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | O estilo do módulo. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | O estilo do módulo. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | O estilo do módulo. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | O estilo do módulo. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | O estilo do módulo. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | O estilo do módulo. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | O estilo do módulo. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | O estilo do módulo. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | O estilo do módulo. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | O estilo do módulo. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | O estilo do módulo. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Opções ### Opções
| Option | Padrão | Descrição | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | O estilo do módulo. | | `style` | `"yellow bold"` | O estilo do módulo. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | O estilo do módulo. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | O estilo do módulo. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Opções
| Option | Padrão | Descrição |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variável | Padrão | Descrição |
| --------- | ------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | O estilo do módulo. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | O estilo do módulo. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | O estilo do módulo. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `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. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables
@ -2491,7 +2619,7 @@ The order in which custom modules are shown can be individually set by including
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `descrição` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

4
docs/pt-BR/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Status do pacote" /></a alt="Status do pacote" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat no Discord" /></a> alt="Chat no Discord" /></a>
@ -150,7 +150,7 @@
#### Instalar via gerenciador de pacotes #### Instalar via gerenciador de pacotes
##### Example: [Homebrew](https://brew.sh/): ##### Exemplo: [Homebrew](https://brew.sh/):
```sh ```sh
brew install starship brew install starship

10
docs/pt-BR/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Pré-requisitos
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

540
docs/pt-PT/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

2
docs/pt-PT/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" /></a> alt="Chat on Discord" /></a>

10
docs/pt-PT/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisites
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

592
docs/ru-RU/config/README.md
View File

@ -21,16 +21,16 @@ symbol = "➜" # Сегменту "symbol" присваеваем знач
disabled = true disabled = true
``` ```
Вы можете изменить расположение файла `starship.toml` переменной окружения `STARSHIP_CONFIG`: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Аналогично в PowerShell (Windows) следует добавить эту строку в `$PROFILE`: Аналогично в PowerShell (Windows) следует добавить эту строку в `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Логгирование (Запись действий) ### Логгирование (Запись действий)
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | Стиль модуля. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` module. | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `"bold blue"` | Стиль модуля. |
| `disabled` | `false` | Disables the `cmake` module. |
### Переменные ### Переменные
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
Модуль `crystal` показывает установленную версию Crystal. Модуль будет показан, если любое из следующих условий соблюдено: Модуль `crystal` показывает установленную версию Crystal. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `shard.yml` - Текущий каталог содержит файл `shard.yml`
- Текущий каталог содержит файл `.cr` - Текущий каталог содержит файл `.cr`
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------- |
| `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. | | `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. |
| `style` | `"bold red"` | Стиль модуля. | | `style` | `"bold red"` | Стиль модуля. |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Отключает модуль `crystal`. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `disabled` | `false` | Disables the `crystal` module. |
### Переменные ### Переменные
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. Модуль будет показан, если любое из следующих условий соблюдено: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | Стиль модуля. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | Стиль модуля. |
| `disabled` | `false` | Disables the `dart` module. |
### Переменные ### Переменные
@ -632,11 +642,11 @@ format = "via [🔰 $version](bold red) "
<details> <details>
<summary>Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога.</summary> <summary>Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога.</summary>
| Advanced Option | По умолчанию | Описание | | Advanced Option | По умолчанию | Описание |
| --------------------------- | ------------ | --------------------------------------------------------------------------------- | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | Количество символов, используемых при использовании логики создания пути из fish. | | `fish_style_pwd_dir_length` | `0` | Количество символов, используемых при использовании логики создания пути из fish. |
| `use_logical_path` | `true` | Отображает логический путь от оболочки (`PWD`) вместо пути от ОС. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ truncation_symbol = "…/"
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | Формат модуля. | | `format` | `"via [$symbol$context]($style) "` | Формат модуля. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | Стиль модуля. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | Стиль модуля. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Переменные ### Переменные
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
Модуль `dotnet` показывает соответствующую версию .NET Core SDK для текущего каталога. Если SDK был закреплен в текущей директории, будет показана закрепленная версия. В противном случае модуль отображает последнюю установленную версию SDK. Модуль `dotnet` показывает соответствующую версию .NET Core SDK для текущего каталога. Если SDK был закреплен в текущей директории, будет показана закрепленная версия. В противном случае модуль отображает последнюю установленную версию SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ----------- | ----------------------------------------- | ----------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Формат модуля. | | `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Формат модуля. |
| `symbol` | `"•NET "` | Символ перед отображением текущей версии dotnet. | | `symbol` | `"•NET "` | Символ перед отображением текущей версии dotnet. |
| `heuristic` | `true` | Использовать быстрое определение версии, для сохранения скорости. | | `heuristic` | `true` | Использовать быстрое определение версии, для сохранения скорости. |
| `style` | `"bold blue"` | Стиль модуля. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Отключает модуль `dotnet`. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | Стиль модуля. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Переменные ### Переменные
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
Модуль `elixir` показывает установленную версию Elixir и Erlang/OTP. Модуль будет показан, если любое из следующих условий соблюдено: Модуль `elixir` показывает установленную версию Elixir и Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `mix.exs`. - Текущий каталог содержит файл `mix.exs`.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ----------------------------------------------------------- | ------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------- |
| `symbol` | `"💧 "` | Символ, используемый перед отображением версии Elixir/Erlang. | | `symbol` | `"💧 "` | Символ, используемый перед отображением версии Elixir/Erlang. |
| `style` | `"bold purple"` | Стиль модуля. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Отключает модуль `elixir`. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | Стиль модуля. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Переменные ### Переменные
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
Модуль `elm` показывает установленную версию Elm. Модуль будет показан, если любое из следующих условий соблюдено: Модуль `elm` показывает установленную версию Elm. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `elm.json` - Текущий каталог содержит файл `elm.json`
- Текущий каталог содержит файл `elm-package.json` - Текущий каталог содержит файл `elm-package.json`
@ -803,12 +822,15 @@ symbol = "🔮 "
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | Стиль модуля. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Отключает модуль `elm`. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | Стиль модуля. |
| `disabled` | `false` | Disables the `elm` module. |
### Переменные ### Переменные
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. Модуль будет показан, если любое из следующих условий соблюдено: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `rebar.config`. - Текущий каталог содержит файл `rebar.config`.
- Текущий каталог содержит файл `erlang.mk`. - Текущий каталог содержит файл `erlang.mk`.
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | Стиль модуля. | | `style` | `"bold red"` | Стиль модуля. |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `disabled` | `false` | Disables the `erlang` module. |
### Переменные ### Переменные
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
Модуль `golang` показывает установленную версию Golang. Модуль будет показан, если любое из следующих условий соблюдено: Модуль `golang` показывает установленную версию Golang. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `go.mod` - Текущий каталог содержит файл `go.mod`
- Текущий каталог содержит файл `go.sum` - Текущий каталог содержит файл `go.sum`
@ -1174,12 +1199,15 @@ behind = "⇣${count}"
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | Стиль модуля. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Отключает модуль `golang`. | | `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"` | Стиль модуля. |
| `disabled` | `false` | Disables the `golang` module. |
### Переменные ### Переменные
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. Модуль будет показан, если любое из следующих условий соблюдено: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `helmfile.yaml` - Текущий каталог содержит файл `helmfile.yaml`
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | Стиль модуля. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | Стиль модуля. |
| `disabled` | `false` | Disables the `helm` module. |
### Переменные ### Переменные
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
Модуль `java` показывает установленную версию Java. Модуль будет показан, если любое из следующих условий соблюдено: Модуль `java` показывает установленную версию Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. | | `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | Стиль модуля. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Отключает модуль `java`. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | Стиль модуля. |
| `disabled` | `false` | Disables the `java` module. |
### Переменные ### Переменные
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. Модуль будет показан, если любое из следующих условий соблюдено: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. Модуль
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | Стиль модуля. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | Стиль модуля. |
| `disabled` | `false` | Disables the `julia` module. |
### Переменные ### Переменные
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. Модуль будет показан, если любое из следующих условий соблюдено: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | Стиль модуля. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | Стиль модуля. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Переменные ### Переменные
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. Модуль будет показан, если любое из следующих условий соблюдено: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. Модуль бу
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | Стиль модуля. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | Стиль модуля. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Переменные ### Переменные
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. Модуль будет показан, если любое из следующих условий соблюдено: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `nim.cfg` - Текущий каталог содержит файл `nim.cfg`
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. Модуль бу
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | Стиль модуля. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` module. | | `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold yellow"` | Стиль модуля. |
| `disabled` | `false` | Disables the `nim` module. |
### Переменные ### Переменные
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
Модуль `nodejs` показывает установленную версию NodeJS. Модуль будет показан, если любое из следующих условий соблюдено: Модуль `nodejs` показывает установленную версию NodeJS. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `package.json` - Текущий каталог содержит файл `package.json`
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,8 +1738,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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"` | Стиль модуля. | | `style` | `"bold green"` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `nodejs`. | | `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
###  Variables ###  Variables
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. Модуль будет показан, если любое из следующих условий соблюдено: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. Модуль
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | Стиль модуля. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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. |
### Переменные ### Переменные
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. Модуль будет показан, если любое из следующих условий соблюдено: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. Модуль б
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | Стиль модуля. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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"` | Стиль модуля. |
| `disabled` | `false` | Disables the `perl` module. |
### Переменные ### Переменные
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
Модуль `php` показывает установленную версию PHP. Модуль будет показан, если любое из следующих условий соблюдено: Модуль `php` показывает установленную версию PHP. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `composer.json` - Текущий каталог содержит файл `composer.json`
- Текущий каталог содержит файл `.php-version` - Текущий каталог содержит файл `.php-version`
- Текущий каталог содержит файл `.php` - The current directory contains a `.php` extension
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🐘 "` | Символ, используемый перед отображением версии PHP. | | `symbol` | `"🐘 "` | Символ, используемый перед отображением версии PHP. |
| `style` | `"147 bold"` | Стиль модуля. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Отключает модуль `php`. | | `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"147 bold"` | Стиль модуля. |
| `disabled` | `false` | Disables the `php` module. |
### Переменные ### Переменные
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. Модуль будет показан, если любое из следующих условий соблюдено: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `spago.dhall` - Текущий каталог содержит файл `spago.dhall`
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | Стиль модуля. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold white"` | Стиль модуля. |
| `disabled` | `false` | Disables the `purescript` module. |
### Переменные ### Переменные
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
Модуль будет показан, если любое из следующих условий соблюдено: By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `.python-version` - Текущий каталог содержит файл `.python-version`
- Текущий каталог содержит файл `requirements.txt` - The current directory contains a `Pipfile` file
- Текущий каталог содержит файл `pyproject.toml`
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- Текущий каталог содержит файл `Pipfile`
- Текущий каталог содержит файл `tox.ini`
- Текущий каталог содержит файл `setup.py`
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- Виртуальная среда в данный момент активирована - Виртуальная среда в данный момент активирована
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| -------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | Стиль модуля. | | `style` | `"yellow bold"` | Стиль модуля. |
| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python | | `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
Модуль `ruby` показывает установленную версию Ruby. Модуль будет показан, если любое из следующих условий соблюдено: By default the `ruby` module shows the currently installed version of Ruby. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл `Gemfile` - Текущий каталог содержит файл `Gemfile`
- Текущий каталог содержит файл `.ruby-version` - Текущий каталог содержит файл `.ruby-version`
@ -2020,12 +2091,15 @@ python_binary = "python3"
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | Стиль модуля. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Отключает модуль `ruby`. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | Стиль модуля. |
| `disabled` | `false` | Disables the `ruby` module. |
### Переменные ### Переменные
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
Модуль `rust` показывает установленную версию Rust. Модуль будет показан, если любое из следующих условий соблюдено: By default the `rust` module shows the currently installed version of Rust. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл `Cargo.toml` - Текущий каталог содержит файл `Cargo.toml`
- Текущий каталог содержит файл с расширением `.rs` - Текущий каталог содержит файл с расширением `.rs`
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | Стиль модуля. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Отключает модуль `rust`. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | Стиль модуля. |
| `disabled` | `false` | Disables the `rust` module. |
### Переменные ### Переменные
@ -2081,6 +2158,45 @@ symbol = "🔺 "
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | Формат модуля. |
| `disabled` | `true` | Disables the `shell` module. |
### Переменные
| Переменная | По умолчанию | Описание |
| ---------- | ------------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Примеры
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2119,7 +2235,7 @@ threshold = 3
## Singularity ## Singularity
Модуль `singularity` показывает текущий образ singularity, если внутри контейнера и `$SINGULARITY_NAME` установлена. The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
### Опции ### Опции
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. Модуль будет показан, если любое из следующих условий соблюдено: By default the `swift` module shows the currently installed version of Swift. Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Стиль модуля. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 202"` | Стиль модуля. |
| `disabled` | `false` | Disables the `swift` module. |
### Переменные ### Переменные
@ -2243,7 +2362,7 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
Модуль `terraform` показывает выбранную рабочую область и версию terraform. The `terraform` module shows the currently selected terraform workspace and version.
::: tip ::: tip
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
Модуль будет показан, если любое из следующих условий соблюдено: By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит папку `.terraform` - Текущий каталог содержит папку `.terraform`
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | Стиль модуля. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Отключает модуль `terraform`. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | Стиль модуля. |
| `disabled` | `false` | Disables the `terraform` module. |
### Переменные ### Переменные
@ -2298,7 +2420,7 @@ format = "[🏎💨 $workspace]($style) "
## Время ## Время
Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры. The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -2308,23 +2430,23 @@ format = "[🏎💨 $workspace]($style) "
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Включить 12-часовое форматирование | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | Стиль модуля времени | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Устанавливает смещение UTC. Range from -24 &lt; x &lt; 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Отключает модуль `time`. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Иначе по умолчанию используется `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------- |
| время | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
\*: Эта переменная может использоваться только в качестве части строки style \*: Эта переменная может использоваться только в качестве части строки style
@ -2342,9 +2464,9 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## Имя пользователя ## Username
Модуль `username` показывает имя текущего пользователя. Модуль будет показан, если любое из следующих условий соблюдено: The `username` module shows active user's username. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий пользователь - root - Текущий пользователь - root
- Текущий пользователь отличается от залогиненного - Текущий пользователь отличается от залогиненного
@ -2359,13 +2481,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------- | ----------------------- | ------------------------------------------------------- | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | Стиль, используемый для пользователя root. | | `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | Стиль, используемый для всех пользователей, кроме root. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | Формат модуля. | | `format` | `"[$user]($style) in "` | Формат модуля. |
| `show_always` | `false` | Всегда показывать модуль `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Отключает модуль `username`. | | `disabled` | `false` | Disables the `username` module. |
### Переменные ### Переменные
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. Модуль будет показан, если любое из следующих условий соблюдено: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | Стиль модуля. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `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. |
### Переменные ### Переменные
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. Модуль будет показан, если любое из следующих условий соблюдено: By default the the `zig` module shows the currently installed version of Zig. Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | Стиль модуля. | | `style` | `"bold yellow"` | Стиль модуля. |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Переменные ### Переменные
@ -2491,7 +2619,7 @@ The order in which custom modules are shown can be individually set by including
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `описание` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

2
docs/ru-RU/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Статус упаковки" /></a alt="Статус упаковки" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Чат в Discord" /></a> alt="Чат в Discord" /></a>

10
docs/ru-RU/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Требования
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

540
docs/tr-TR/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` 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. |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Advanced Option | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | The style for the module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. The module
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | The style for the module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `golang` 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. |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | The style for the module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. The module will be shown if any of the following conditions are met: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. The module will b
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` 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. |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. The module wi
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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 ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | The style for the module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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. |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | The style for the module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` 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. |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file - The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` 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. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Options ### Options
| Option | Default | Description | | 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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | The style for the module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. The module will
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Options
| Option | Default | Description |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| Variable | Default | Description |
| --------- | ------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` 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. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
The module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | The style for the module. | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | The style for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: 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:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables

2
docs/tr-TR/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" /></a> alt="Chat on Discord" /></a>

10
docs/tr-TR/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### Prerequisites
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

4
docs/vi-VN/README.md
View File

@ -113,9 +113,9 @@ eval $(starship init ion)
#### Elvish #### Elvish
::: warning Only elvish v0.15 or higher is supported. ::: ::: warning Chỉ elvish v0.15 hoặc cao hơn được hỗ trợ. :::
Add the following to the end of `~/.elvish/rc.elv`: Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`:
```sh ```sh
# ~/.elvish/rc.elv # ~/.elvish/rc.elv

552
docs/vi-VN/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # "success_symbol" được thiết l
disabled = true disabled = true
``` ```
Bạn có thể thay đổi đường dẫn mặc định của tệp tin `starship.toml` quan biến môi trường `STARSHIP_CONFIG`: Bạn thay đổi địa chỉ tệp tin cấu hình mặc định bằng biến môi trường `STARSHIP_CONFIG`:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Tương đương trong PowerShell (Windows) sẽ được thêm dòng này vào `$PROFILE` của bạn: Tương đương trong PowerShell (Windows) sẽ được thêm dòng này vào `$PROFILE` của bạn:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -173,7 +173,7 @@ Mặc định `format` được sử dụng để định nghĩa định dạng
```toml ```toml
format = "$all" format = "$all"
# Which is equivalent to # Nó tương đương với
format = """ format = """
$username\ $username\
$hostname\ $hostname\
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -372,7 +373,7 @@ Kí tự sẽ nói cho bạn câu lệnh cuối liệu thành công hay thất b
Mặc định, nó chỉ thay đổi màu. Nếu bạn cũng muốn thay đổi hình dạng, tham khảo [ví dụ này](#with-custom-error-shape). Mặc định, nó chỉ thay đổi màu. Nếu bạn cũng muốn thay đổi hình dạng, tham khảo [ví dụ này](#with-custom-error-shape).
::: warning `error_symbol` is not supported on elvish shell. ::: ::: warning `error_symbol` không được hỗ trợ trên elvish shell. :::
### Các tuỳ chọn ### Các tuỳ chọn
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
Module `cmake` cho biết phiên bản Cmake hiện tại được cài đặt nếu mọi điều kiện sau được thoả mãn: `cmake` module cho biết phiên bản Cmake hiện tại đã được cài đặt. Mặc định module sẽ được kích hoạt nếu thoả mãn bất kì điều kiện nào dưới đây:
- Đường dẫn hiện tại chứa một tập tin `CmakeLists.txt` - Đường dẫn hiện tại chứa một tập tin `CmakeLists.txt`
- Đường dẫn hiện tại chứa một tập tin `CMakeCache.txt` - Đường dẫn hiện tại chứa một tập tin `CMakeCache.txt`
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ------------------------------------------ | | ------------------- | -------------------------------------- | -------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"喝 "` | Kí hiệu sử dụng trước phiên bản của cmake. | | `symbol` | `"喝 "` | Kí hiệu sử dụng trước phiên bản của cmake. |
| `style` | `"bold blue"` | Kiểu cho module. | | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này |
| `disabled` | `false` | Vô hiệu module `cmake`. | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Tên tệp nào sẽ kích hoạt mô-đun này |
| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này |
| `style` | `"bold blue"` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu hoá `cmake` module. |
### Các biến ### Các biến
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
Module `crystal` cho biết phiên bản hiện tại của Crystal được đã cài đặt. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: Module `crystal` cho biết phiên bản hiện tại của Crystal được đã cài đặt. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Đường dẫn hiện tại chứa một tập tin `shard.yml` - Đường dẫn hiện tại chứa một tập tin `shard.yml`
- Đường dẫn hiện tại chứa một tập tin `.cr` - Đường dẫn hiện tại chứa một tập tin `.cr`
### Options ### Options
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. | | `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. |
| `style` | `"bold red"` | Kiểu cho module. | | `style` | `"bold red"` | Kiểu cho module. |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `detect_extensions` | `["cr"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Vô hiệu hoá module `crystal`. | | `detect_files` | `["shard.yml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `disabled` | `false` | Vô hiệu hoá module `crystal`. |
### Các biến ### Các biến
@ -573,26 +580,29 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
Module `dart` cho biết phiên bản của Dart đã cài đặt. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: Module `dart` cho biết phiên bản của Dart đã cài đặt. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- Đường dẫn hiện tại chứa một tập tin với phần mở rộng `.dart` - Đường dẫn hiện tại chứa một tập tin với phần mở rộng `.dart`
- Đường dẫn hiện tại chứa một đường dẫn `.dart_tool` - Đường dẫn hiện tại chứa một đường dẫn `.dart_tool`
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - Đường dẫn hiện tại chứa một tệp tin `pubspec.yaml`, `pubspec.yml` hoặc `pubspec.lock`
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | Một chuỗi định dạng hiển thị biểu tượng của Dart |
| `style` | `"bold blue"` | Kiểu cho module. | | `detect_extensions` | `['dart']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[".dart_tool"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold blue"` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `dart` module. |
### Các biến ### Các biến
| Biến | Ví dụ | Mô tả | | Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- | | --------- | -------- | -------------------------------- |
| version | `v2.8.4` | The version of `dart` | | version | `v2.8.4` | Phiên bản của `dart` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` | | style\* | | Giá trị ghi đè của `style` |
@ -607,9 +617,9 @@ Module `dart` cho biết phiên bản của Dart đã cài đặt. Module cho s
format = "via [🔰 $version](bold red) " format = "via [🔰 $version](bold red) "
``` ```
## Directory ## Đường dẫn
The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. `directory` module hiển thị đường dẫn thư mục hiện hành của bạn,, cắt ngắn ba thư mục cha. Đường dẫn của bạn cũng sẽ được cắt ngắn tới đường dẫn gốc của git repo hiện tại của bạn.
When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
@ -632,11 +642,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Mặc định | Mô tả | | Advanced Option | Mặc định | Mô tả |
| --------------------------- | -------- | ---------------------------------------------------------------------------------------- | | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. | | `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | Kiểu cho module. | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Các biến ### Các biến
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ----------- | ----------------------------------------- | -------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Định dạng cho module. | | `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Định dạng cho 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. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | Kiểu cho module. | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `dotnet` module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Các biến ### Các biến
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `mix.exs`. - Đường dẫn hiện tại chứa một tập tin `mix.exs`.
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | Kiểu cho module. | | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | Kiểu cho module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Các biến ### Các biến
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `elm.json` - Đường dẫn hiện tại chứa một tập tin `elm.json`
- Đường dẫn hiện tại chứa một tập tin `elm-package.json` - Đường dẫn hiện tại chứa một tập tin `elm-package.json`
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. Module cho sẽ
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | Kiểu cho module. | | `detect_extensions` | `["elm"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `elm` module. |
### Các biến ### Các biến
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `rebar.config`. - Đường dẫn hiện tại chứa một tập tin `rebar.config`.
- Đường dẫn hiện tại chứa một tập tin `erlang.mk`. - Đường dẫn hiện tại chứa một tập tin `erlang.mk`.
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | Kiểu cho module. | | `style` | `"bold red"` | Kiểu cho module. |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Các biến ### Các biến
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `go.mod` - Đường dẫn hiện tại chứa một tập tin `go.mod`
- Đường dẫn hiện tại chứa một tập tin `go.sum` - Đường dẫn hiện tại chứa một tập tin `go.sum`
@ -1174,12 +1199,15 @@ The `golang` module shows the currently installed version of Golang. Module cho
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | Kiểu cho module. | | `detect_extensions` | `["go"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `golang` module. | | `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `["Godeps"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold cyan"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `golang` module. |
### Các biến ### Các biến
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `helmfile.yaml` - Đường dẫn hiện tại chứa một tập tin `helmfile.yaml`
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold white"` | Kiểu cho module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `helm` module. |
### Các biến ### Các biến
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | Định dạng cho module. | | `format` | `"via [${symbol}(${version} )]($style)"` | Định dạng cho module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `style` | `"red dimmed"` | Kiểu cho module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `java` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `java` module. |
### Các biến ### Các biến
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. Module cho s
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold purple"` | Kiểu cho module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `julia` module. |
### Các biến ### Các biến
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold blue"` | Kiểu cho module. | | `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | Kiểu cho module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Các biến ### Các biến
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. Module cho sẽ
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | Kiểu cho module. | | `detect_extensions` | `["lua"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold blue"` | Kiểu cho module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Các biến ### Các biến
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `nim.cfg` - Đường dẫn hiện tại chứa một tập tin `nim.cfg`
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. Module cho sẽ
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | Kiểu cho module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `nim` module. | | `detect_files` | `["nim.cfg"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold yellow"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `nim` module. |
### Các biến ### Các biến
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `package.json` - Đường dẫn hiện tại chứa một tập tin `package.json`
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,6 +1738,9 @@ The `nodejs` module shows the currently installed version of NodeJS. Module cho
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `["package.json", ".node-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `["node_modules"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold green"` | Kiểu cho module. | | `style` | `"bold green"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `nodejs` 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. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. Module cho s
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | Kiểu cho module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `ocaml` module. | | `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `["_opam", "esy.lock"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold yellow"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Các biến ### Các biến
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. Module cho sẽ
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | Kiểu cho module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `perl` module. | | `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold 149"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `perl` module. |
### Các biến ### Các biến
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `composer.json` - Đường dẫn hiện tại chứa một tập tin `composer.json`
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | Kiểu cho module. | | `detect_extensions` | `["php"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `php` module. | | `detect_files` | `["composer.json", ".php-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"147 bold"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `php` module. |
### Các biến ### Các biến
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- Đường dẫn hiện tại chứa một tập tin `spago.dhall` - Đường dẫn hiện tại chứa một tập tin `spago.dhall`
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | Kiểu cho module. | | `detect_extensions` | `["purs"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `purescript` module. | | `detect_files` | `["spago.dhall"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold white"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `purescript` module. |
### Các biến ### Các biến
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- Đường dẫn hiện tại chứa một tập tin `requirements.txt`
- Đường dẫn hiện tại chứa một tập tin `pyproject.toml`
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file - The current directory contains a `Pipfile` file
- Đường dẫn hiện tại chứa một tập tin `tox.ini`
- Đường dẫn hiện tại chứa một tập tin `setup.py`
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | Định dạng cho module. | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | Định dạng cho module. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | Kiểu cho module. | | `style` | `"yellow bold"` | Kiểu cho module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `python` 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. |
::: thử thuật ::: thử thuật
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the `ruby` module shows the currently installed version of Ruby. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ The `ruby` module shows the currently installed version of Ruby. Module cho sẽ
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | Kiểu cho module. | | `detect_extensions` | `["rb"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `ruby` module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold red"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Các biến ### Các biến
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the `rust` module shows the currently installed version of Rust. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | Kiểu cho module. | | `detect_extensions` | `["rs"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `rust` module. | | `detect_files` | `["Cargo.toml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold red"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `rust` module. |
### Các biến ### Các biến
@ -2081,6 +2158,45 @@ The `rust` module shows the currently installed version of Rust. Module cho sẽ
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: thử thuật
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | Định dạng cho module. |
| `disabled` | `true` | Disables the `shell` module. |
### Các biến
| Biến | Mặc định | Mô tả |
| --------- | -------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Các vị dụ
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the `swift` module shows the currently installed version of Swift. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Kiểu cho module. | | `detect_extensions` | `["swift"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `swift` module. | | `detect_files` | `["Package.swift"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold 202"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `swift` module. |
### Các biến ### Các biến
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | Kiểu cho module. | | `detect_extensions` | `["tf", "hcl"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[".terraform"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold 105"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `terraform` module. |
### Các biến ### Các biến
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | Kiểu cho module. | | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `detect_files` | `["Vagrantfile"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"cyan bold"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `Vagrant` module. |
### Các biến ### Các biến
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the the `zig` module shows the currently installed version of Zig. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | Kiểu cho module. | | `style` | `"bold yellow"` | Kiểu cho module. |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
### Các biến ### Các biến
@ -2491,7 +2619,7 @@ The order in which custom modules are shown can be individually set by including
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `mô tả` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

4
docs/vi-VN/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Trạng thái đóng gói" /></a alt="Trạng thái đóng gói" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Trò chuyện trên Discord" /></a> alt="Trò chuyện trên Discord" /></a>
@ -221,7 +221,7 @@
#### Elvish #### Elvish
**Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: **Cảnh báo** Chỉ elvish v0.15 hoặc cao hơn được hỗ trợ. Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`:
```sh ```sh
# ~/.elvish/rc.elv # ~/.elvish/rc.elv

14
docs/vi-VN/installing/README.md
View File

@ -8,10 +8,20 @@
Đối với đa số người dùng, các hướng dẫn trên [trang chính](/guide/#🚀-installation) sẽ làm việc tốt. Tuy nhiên, với một vài nền tảng đặc biệt hơn, các hướng dẫn khác nhau là cần thiết. Đối với đa số người dùng, các hướng dẫn trên [trang chính](/guide/#🚀-installation) sẽ làm việc tốt. Tuy nhiên, với một vài nền tảng đặc biệt hơn, các hướng dẫn khác nhau là cần thiết.
Có rất nhiều nền tảng bên ngoài, rằng chúng đã không khớp như trong tệp tin README.md, do đó đây là vài hướng dẫn cài đặt cho những nền tảng khác đến từ cộng đồng. Của bạn không có ở đây? Xin hãy thêm nó vào đây nếu bạn tìm ra nó! Có rất nhiều nền tảng bên ngoài, rằng chúng đã không khớp như trong tệp tin README.md, do đó đây là vài hướng dẫn cài đặt cho những nền tảng khác đến từ cộng đồng. Của bạn không có ở đây? Xin hãy thêm nó vào đây nếu bạn tìm ra nó!
## [termux](https://termux.com)
### Yêu cầu
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)
### Lấy tệp tin nhị phân ### Getting the Binary
#### Lệnh #### Lệnh
@ -35,7 +45,7 @@ Thêm `pkgs.starship` vào `environment.packages` trong `configuration.nix` củ
sudo nixos-rebuild switch sudo nixos-rebuild switch
``` ```
### Sửa những đoạn mã khởi tạo ### Modifying Init Scripts
#### Với Nix và home-manager, sử dụng zsh: #### Với Nix và home-manager, sử dụng zsh:

2
docs/vi-VN/migrating-to-0.45.0/README.md
View File

@ -125,7 +125,7 @@ error_symbol = "[✖](bold red)"
++ format = "took [$duration]($style) " ++ format = "took [$duration]($style) "
``` ```
#### Directory #### Đường dẫn
| Removed Property | Replacement | | Removed Property | Replacement |
| ---------------- | ----------- | | ---------------- | ----------- |

588
docs/zh-CN/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
你可以设置环境变量 `STARSHIP_CONFIG` 来修改 starship 查找配置文件 `starship.toml` 时查找的位置： You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
在 PowerShell (Windows) 中，在 `$PROFILE` 中添加下面的代码行能达到同样的效果： 在 PowerShell (Windows) 中，在 `$PROFILE` 中添加下面的代码行能达到同样的效果：
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### 日志 ### 日志
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | 此组件的样式。 | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` module. | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `"bold blue"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. 此组件将在符合以下任意条件之一时显示： The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `shard.yml` 文件 - 当前目录包含一个 `shard.yml` 文件
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | 此组件的样式。 | | `style` | `"bold red"` | 此组件的样式。 |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. 此组件将在符合以下任意条件之一时显示： The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | 此组件的样式。 | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ format = "via [🔰 $version](bold red) "
<details> <details>
<summary>此组件有几个高级配置选项来控制当前目录路径的显示方式。</summary> <summary>此组件有几个高级配置选项来控制当前目录路径的显示方式。</summary>
| Advanced Option | 默认值 | 描述 | | Advanced Option | 默认值 | 描述 |
| --------------------------- | ------ | ------------------------------------------------ | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | 使用 fish shell 当前目录路径逻辑时每个省略目录名使用的字符数。 | | `fish_style_pwd_dir_length` | `0` | 使用 fish shell 当前目录路径逻辑时每个省略目录名使用的字符数。 |
| `use_logical_path` | `true` | 显示由 shell 提供的逻辑路径（`PWD`）而不是 OS 提供的路径。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | 组件格式化模板。 | | `format` | `"via [$symbol$context]($style) "` | 组件格式化模板。 |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | 此组件的样式。 | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
`dotnet` 模块显示与当前目录下使用的 .NET Core SDK 相关联的版本。 如果当前目录已被绑定了一个版本的 SDK，则显示被帮定的版本。 否则此组件将显示最新安装的 SDK 版本。 `dotnet` 模块显示与当前目录下使用的 .NET Core SDK 相关联的版本。 如果当前目录已被绑定了一个版本的 SDK，则显示被帮定的版本。 否则此组件将显示最新安装的 SDK 版本。
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ----------- | ----------------------------------------- | ------------------------------ | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | 组件格式化模板。 | | `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | 组件格式化模板。 |
| `symbol` | `"•NET "` | 这个字段的内容会显示在当前 .NET 版本之前。 | | `symbol` | `"•NET "` | 这个字段的内容会显示在当前 .NET 版本之前。 |
| `heuristic` | `true` | 使用更快的版本探测机制以保证 starship 的运行速度。 | | `heuristic` | `true` | 使用更快的版本探测机制以保证 starship 的运行速度。 |
| `style` | `"bold blue"` | 此组件的样式。 | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | 禁用 `dotnet` 组件。 | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 此组件将在符合以下任意条件之一时显示： The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `mix.exs` 文件. - 当前目录包含一个 `mix.exs` 文件.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | 此组件的样式。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | 此组件的样式。 |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. 此组件将在符合以下任意条件之一时显示： The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `elm.json` 文件 - 当前目录包含一个 `elm.json` 文件
- 当前目录包含 `elm-package.json` 文件 - 当前目录包含 `elm-package.json` 文件
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. 此组件将在
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | 此组件的样式。 | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. 此组件将在符合以下任意条件之一时显示： The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `rebar.config` 文件. - 当前目录包含一个 `rebar.config` 文件.
- 当前目录包含一个 `erlang.mk` 文件. - 当前目录包含一个 `erlang.mk` 文件.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | 此组件的样式。 | | `style` | `"bold red"` | 此组件的样式。 |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
`golang` 组件显示当前安装的 Golang 版本。 此组件将在符合以下任意条件之一时显示： `golang` 组件显示当前安装的 Golang 版本。 By default the module will be shown if any of the following conditions are met:
- 当前目录包含 `go.mod` 文件 - 当前目录包含 `go.mod` 文件
- 当前目录包含 `go.sum` 文件 - 当前目录包含 `go.sum` 文件
@ -1174,12 +1199,15 @@ behind = "⇣${count}"
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | 此组件的样式。 | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | 禁用 `golang` 组件。 | | `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"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. 此组件将在符合以下任意条件之一时显示： The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `helmfile.yaml` 文件 - 当前目录包含一个 `helmfile.yaml` 文件
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | 此组件的样式。 | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
`java` 组件显示当前安装的 Java 版本。 此组件将在符合以下任意条件之一时显示： `java` 组件显示当前安装的 Java 版本。 By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 | | `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | 此组件的样式。 | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | 禁用 `java` 组件。 | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. 此组件将在符合以下任意条件之一时显示： The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. 此组件将
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | 此组件的样式。 | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. 此组件将在符合以下任意条件之一时显示： The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | 此组件的样式。 | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | 此组件的样式。 |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. 此组件将在符合以下任意条件之一时显示： The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. 此组件将在
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | 此组件的样式。 | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | 此组件的样式。 |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. 此组件将在符合以下任意条件之一时显示： The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `nim.cfg` 文件 - 当前目录包含一个 `nim.cfg` 文件
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. 此组件将在
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | 此组件的样式。 | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` module. | | `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold yellow"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
`nodejs` 组件显示当前安装的 NodeJS 版本。 此组件将在符合以下任意条件之一时显示： `nodejs` 组件显示当前安装的 NodeJS 版本。 By default the module will be shown if any of the following conditions are met:
- 当前目录包含 `package.json` 文件 - 当前目录包含 `package.json` 文件
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,8 +1738,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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"` | 此组件的样式。 | | `style` | `"bold green"` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `nodejs` 组件。 | | `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
###  Variables ###  Variables
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. 此组件将在符合以下任意条件之一时显示： The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. 此组件将
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | 此组件的样式。 | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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. |
### Variables ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. 此组件将在符合以下任意条件之一时显示： The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. 此组件将在
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | 此组件的样式。 | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
`php` 组件显示当前安装的 PHP 版本。 此组件将在符合以下任意条件之一时显示： `php` 组件显示当前安装的 PHP 版本。 By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `composer.json` 文件 - 当前目录包含一个 `composer.json` 文件
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- 当前目录包含一个 `.php` 文件 - The current directory contains a `.php` extension
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------- | | ------------------- | ------------------------------------ | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🐘 "` | 这个字段的内容会显示在当前 PHP 版本之前。 | | `symbol` | `"🐘 "` | 这个字段的内容会显示在当前 PHP 版本之前。 |
| `style` | `"147 bold"` | 此组件的样式。 | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | 禁用 `php` 组件。 | | `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"147 bold"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. 此组件将在符合以下任意条件之一时显示： The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- 当前目录包含一个 `spago.dhall` 文件 - 当前目录包含一个 `spago.dhall` 文件
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | 此组件的样式。 | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold white"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ format = "via [$symbol$version](bold white)"
如果`pyenv_version_name`被设置为`true`, 本组件将会展示pyenv版本名。 否则则显示通过`python --version`获得的版本号 如果`pyenv_version_name`被设置为`true`, 本组件将会展示pyenv版本名。 否则则显示通过`python --version`获得的版本号
此组件将在符合以下任意条件之一时显示： By default the module will be shown if any of the following conditions are met:
- 当前目录包含 `.python-version` 文件 - 当前目录包含 `.python-version` 文件
- 当前目录包含 `requirements.txt` 文件 - The current directory contains a `Pipfile` file
- 当前目录包含 `pyproject.toml` 文件 - The current directory contains a `__init__.py` file
- 当前目录包含一个扩展名名为`.py`的文件(以及`scan_for_pyfile`为true) - The current directory contains a `pyproject.toml` file
- 当前目录包含 `Pipfile` 文件 - The current directory contains a `requirements.txt` file
- 当前目录包含一个 `tox.ini` 文件 - The current directory contains a `setup.py` file
- 当前目录包含一个 `setup.py` 文件 - The current directory contains a `tox.ini` file
- 当前目录包含一个名为`__init__.py`的文件 - The current directory contains a file with the `.py` extension.
- 当前处于一个活跃的 python 虚拟环境中 - 当前处于一个活跃的 python 虚拟环境中
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| -------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | 组件格式化模板。 | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\))]($style)'` | 组件格式化模板。 |
| `symbol` | `"🐍 "` | 用于表示Python的格式化字符串。 | | `symbol` | `"🐍 "` | 用于表示Python的格式化字符串。 |
| `style` | `"yellow bold"` | 此组件的样式。 | | `style` | `"yellow bold"` | 此组件的样式。 |
| `pyenv_version_name` | `false` | 使用 pyenv 获取 Python 版本 | | `pyenv_version_name` | `false` | 使用 pyenv 获取 Python 版本 |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | 如果设置为false, 在本目录下的Python文件将不会在本组件中显示。 | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | 禁用 `python` 组件。 | | `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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
`ruby` 组件显示当前安装的 Ruby 版本。 此组件将在符合以下任意条件之一时显示： By default the `ruby` module shows the currently installed version of Ruby. 此组件将在符合以下任意条件之一时显示：
- 当前目录包含 `Gemfile` 文件 - 当前目录包含 `Gemfile` 文件
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ python_binary = "python3"
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | 此组件的样式。 | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | 禁用 `ruby` 组件。 | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
`rust` 组件显示当前安装的 Rust 版本。 此组件将在符合以下任意条件之一时显示： By default the `rust` module shows the currently installed version of Rust. 此组件将在符合以下任意条件之一时显示：
- 当前目录包含 `Cargo.toml` 文件 - 当前目录包含 `Cargo.toml` 文件
- 当前目录包含一个使用 `.rs` 扩展名的文件 - 当前目录包含一个使用 `.rs` 扩展名的文件
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | 此组件的样式。 | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | 禁用 `rust` 组件。 | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ symbol = "🔺 "
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。
:::
### 配置项
| Option | 默认值 | 描述 |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | 组件格式化模板。 |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| 字段 | 默认值 | 描述 |
| --------- | --- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. 此组件将在符合以下任意条件之一时显示： By default the `swift` module shows the currently installed version of Swift. 此组件将在符合以下任意条件之一时显示：
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | 此组件的样式。 | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 202"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2243,7 +2362,7 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
`terraform` 组件显示当前选定的 terraform 工作区和版本。 The `terraform` module shows the currently selected terraform workspace and version.
::: tip ::: tip
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
此组件将在符合以下任意条件之一时显示： By default the module will be shown if any of the following conditions are met:
- 当前目录包含 `.terraform` 目录 - 当前目录包含 `.terraform` 目录
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | 此组件的样式。 | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | 禁用 `terraform` 组件。 | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2298,7 +2420,7 @@ format = "[🏎💨 $workspace]($style) "
## Time ## Time
`time` 组件显示当前的 **本地** 时间。 `format` 字段值会提供给 [`chrono`](https://crates.io/crates/chrono) crate 用来控制时间显示方式。 请参阅 [chrono strftime 文档](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) 以了解可用格式选项。 The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -2308,17 +2430,17 @@ format = "[🏎💨 $workspace]($style) "
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 启用 12 小时格式 | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | 见下文解释 | 用来格式化时间显示的 [chrono 格式字符串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | 显示时间的样式。 | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | 设置所用 UTC 偏移量。 Range from -24 &lt; x &lt; 24. 允许使用浮点数来得到 30/45 分钟的时区偏移。 | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | 禁用 `time` 组件。 | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. 否则，其默认值为 `"%T"`。 Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
@ -2344,7 +2466,7 @@ time_range = "10:00:00-14:00:00"
## Username ## Username
`username` 组件显示当前活跃的用户名。 此组件将在符合以下任意条件之一时显示： The `username` module shows active user's username. 此组件将在符合以下任意条件之一时显示：
- 当前用户是 root - 当前用户是 root
- 当前用户与登录用户不相同 - 当前用户与登录用户不相同
@ -2359,13 +2481,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ------------- | ----------------------- | ------------------- | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | 当前用户为 root 时使用的样式。 | | `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | 非 root 用户使用的样式。 | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | 组件格式化模板。 | | `format` | `"[$user]($style) in "` | 组件格式化模板。 |
| `show_always` | `false` | 总是显示 `username` 组件。 | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | 禁用 `username` 组件。 | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. 此组件将在符合以下任意条件之一时显示： The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | 此组件的样式。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `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. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. 此组件将在符合以下任意条件之一时显示： By default the the `zig` module shows the currently installed version of Zig. 此组件将在符合以下任意条件之一时显示：
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | Option | 默认值 | 描述 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | 此组件的样式。 | | `style` | `"bold yellow"` | 此组件的样式。 |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables
@ -2491,7 +2619,7 @@ The order in which custom modules are shown can be individually set by including
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `描述` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

2
docs/zh-CN/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="加入 Discord" /></a> alt="加入 Discord" /></a>

10
docs/zh-CN/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### 前置要求
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)

588
docs/zh-TW/config/README.md
View File

@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true disabled = true
``` ```
你可以藉由修改 `STARSHIP_CONFIG`環境變數而改變預設的`starship.toml` 檔案位置 You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship/config.toml
``` ```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell ```powershell
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
``` ```
### Logging ### Logging
@ -227,6 +227,7 @@ $jobs\
$battery\ $battery\
$time\ $time\
$status\ $status\
$shell\
$character""" $character"""
``` ```
@ -423,19 +424,22 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file - The current directory contains a `CMakeCache.txt` file
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | -------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | 這個模組的風格。 | | `detect_extensions` | `[]` | Which extensions should trigger this moudle |
| `disabled` | `false` | Disables the `cmake` module. | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -538,19 +542,22 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
`crystal` 模組顯示現在所安裝的Crystal版本 這個模組在下列其中一個條件達成時顯示： `crystal` 模組顯示現在所安裝的Crystal版本 By default the module will be shown if any of the following conditions are met:
- 現在資料夾中含有一個 `shard.yml` 檔案 - 現在資料夾中含有一個 `shard.yml` 檔案
- 現在資料夾中含有一個`.cr`檔案 - 現在資料夾中含有一個`.cr`檔案
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | --------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | 這個模組的風格。 | | `style` | `"bold red"` | 這個模組的風格。 |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `crystal` module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `crystal` module. |
### Variables ### Variables
@ -573,20 +580,23 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. 這個模組在下列其中一個條件達成時顯示： The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `style` | `"bold blue"` | 這個模組的風格。 | | `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `dart` module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -632,11 +642,11 @@ format = "via [🔰 $version](bold red) "
<details> <details>
<summary>這個模組有些進階設定選項可以控制顯示資料夾。</summary> <summary>這個模組有些進階設定選項可以控制顯示資料夾。</summary>
| Advanced Option | 預設 | 說明 | | Advanced Option | 預設 | 說明 |
| --------------------------- | ------ | ------------------------------------------------ | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | 當使用 fish shell 的 pwd 路徑邏輯時使用的字元數量。 | | `fish_style_pwd_dir_length` | `0` | 當使用 fish shell 的 pwd 路徑邏輯時使用的字元數量。 |
| `use_logical_path` | `true` | 顯示 shell (`PWD`) 提供的邏輯路徑，而不是 OS 的路徑。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
@ -675,13 +685,16 @@ The `docker_context` module shows the currently active [Docker context](https://
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | 這個模組的風格。 | | `only_with_files` | `true` | Only show when there's a match |
| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `disabled` | `false` | Disables the `docker_context` module. | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -706,7 +719,7 @@ format = "via [🐋 $context](blue bold)"
`dotnet` 模組顯示現在資料夾使用的 .NET Core SDK 的版本。 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。 `dotnet` 模組顯示現在資料夾使用的 .NET Core SDK 的版本。 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。
This module will only be shown in your prompt when one or more of the following files are present in the current directory: By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json` - `global.json`
- `project.json` - `project.json`
@ -726,13 +739,16 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ----------- | ----------------------------------------- | ---------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | | `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
| `symbol` | `"•NET "` | 在顯示 dotnet 版本之前用的符號。 | | `symbol` | `"•NET "` | 在顯示 dotnet 版本之前用的符號。 |
| `heuristic` | `true` | 使用更快速的版本偵測法來保持 starship 的速度。 | | `heuristic` | `true` | 使用更快速的版本偵測法來保持 starship 的速度。 |
| `style` | `"bold blue"` | 這個模組的風格。 | | `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `disabled` | `false` | 停用 `dotnet` 模組。 | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -758,18 +774,21 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 這個模組在下列其中一個條件達成時顯示： The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `mix.exs` 檔案. - 現在資料夾中包含一個 `mix.exs` 檔案.
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | 這個模組的風格。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `elixir` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | 這個模組的風格。 |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -793,7 +812,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. 這個模組在下列其中一個條件達成時顯示： The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `elm.json` 檔案 - 現在資料夾中包含一個 `elm.json` 檔案
- 現在資料夾中包含一個 `elm-package.json` 檔案 - 現在資料夾中包含一個 `elm-package.json` 檔案
@ -803,12 +822,15 @@ The `elm` module shows the currently installed version of Elm. 這個模組在
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | -------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | 這個模組的風格。 | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `elm` module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -868,19 +890,22 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. 這個模組在下列其中一個條件達成時顯示： The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `rebar.config` 檔案. - 現在資料夾中包含一個 `rebar.config` 檔案.
- 現在資料夾中包含一個 `erlang.mk` 檔案. - 現在資料夾中包含一個 `erlang.mk` 檔案.
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | 這個模組的風格。 | | `style` | `"bold red"` | 這個模組的風格。 |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `erlang` module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Variables ### Variables
@ -1161,7 +1186,7 @@ behind = "⇣${count}"
## Golang ## Golang
`golang` 模組顯示現在安裝的 Golang 版本。 這個模組在下列其中一個條件達成時顯示： `golang` 模組顯示現在安裝的 Golang 版本。 By default the module will be shown if any of the following conditions are met:
- 現在資料夾中含有一個 `go.mod` 檔案 - 現在資料夾中含有一個 `go.mod` 檔案
- 現在資料夾中含有一個 `go.sum` 檔案 - 現在資料夾中含有一個 `go.sum` 檔案
@ -1174,12 +1199,15 @@ behind = "⇣${count}"
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ---------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | 這個模組的風格。 | | `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | 停用 `golang` 模組。 | | `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"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1202,19 +1230,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. 這個模組在下列其中一個條件達成時顯示： The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `helmfile.yaml` 檔案 - 現在資料夾中包含一個 `helmfile.yaml` 檔案
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `style` | `"bold white"` | 這個模組的風格。 | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `helm` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1272,19 +1303,22 @@ disabled = false
## Java ## Java
`java` 模組顯示現在安裝的 Java 版本。 這個模組在下列其中一個條件達成時顯示： `java` 模組顯示現在安裝的 Java 版本。 By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ---------------------------------------- | ----------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | | `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
| `style` | `"red dimmed"` | 這個模組的風格。 | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `disabled` | `false` | 停用 `java` 模組。 | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1341,7 +1375,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. 這個模組在下列其中一個條件達成時顯示： The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1349,12 +1383,15 @@ The `julia` module shows the currently installed version of Julia. 這個模組
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
| `style` | `"bold purple"` | 這個模組的風格。 | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `julia` module. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1377,19 +1414,22 @@ symbol = "∴ "
## Kotlin ## Kotlin
The `kotlin` module shows the currently installed version of Kotlin. 這個模組在下列其中一個條件達成時顯示： The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file - The current directory contains a `.kt` or a `.kts` file
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
| `style` | `"bold blue"` | 這個模組的風格。 | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `kotlin` module. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Variables ### Variables
@ -1482,7 +1522,7 @@ disabled = true
## Lua ## Lua
The `lua` module shows the currently installed version of Lua. 這個模組在下列其中一個條件達成時顯示： The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory - The current directory contains a `lua` directory
@ -1490,13 +1530,16 @@ The `lua` module shows the currently installed version of Lua. 這個模組在
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | 這個模組的風格。 | | `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `disabled` | `false` | Disables the `lua` module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables ### Variables
@ -1602,7 +1645,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. 這個模組在下列其中一個條件達成時顯示： The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `nim.cfg` 檔案 - 現在資料夾中包含一個 `nim.cfg` 檔案
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1611,12 +1654,15 @@ The `nim` module shows the currently installed version of Nim. 這個模組在
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | 這個模組的風格。 | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `nim` module. | | `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold yellow"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -1678,7 +1724,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
`nodejs` 模組顯示現在安裝的 NodeJS 版本。 這個模組在下列其中一個條件達成時顯示： `nodejs` 模組顯示現在安裝的 NodeJS 版本。 By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `package.json` 檔案 - 現在資料夾中包含一個 `package.json` 檔案
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1692,8 +1738,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `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"` | 這個模組的風格。 | | `style` | `"bold green"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `nodejs` 模組。 | | `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. | | `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. |
###  Variables ###  Variables
@ -1717,7 +1766,7 @@ format = "via [🤖 $version](bold green) "
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. 這個模組在下列其中一個條件達成時顯示： The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1728,12 +1777,15 @@ The `ocaml` module shows the currently installed version of OCaml. 這個模組
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | 這個模組的風格。 | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `ocaml` 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. |
### Variables ### Variables
@ -1837,7 +1889,7 @@ format = "via [🎁 $version](208 bold) "
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. 這個模組在下列其中一個條件達成時顯示： The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1847,12 +1899,15 @@ The `perl` module shows the currently installed version of Perl. 這個模組在
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `style` | `"bold 149"` | 這個模組的風格。 | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `perl` 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"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -1873,20 +1928,23 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. 這個模組在下列其中一個條件達成時顯示： The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `composer.json` 檔案 - 現在資料夾中包含一個 `composer.json` 檔案
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` extension
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | 這個模組的風格。 | | `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `php` module. | | `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"147 bold"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1909,19 +1967,22 @@ format = "via [🔹 $version](147 bold) "
## PureScript ## PureScript
The `purescript` module shows the currently installed version of PureScript version. 這個模組在下列其中一個條件達成時顯示： The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `spago.dhall` 檔案 - 現在資料夾中包含一個 `spago.dhall` 檔案
- The current directory contains a \*.purs files - The current directory contains a file with the `.purs` extension
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | 這個模組的風格。 | | `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `purescript` module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold white"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -1948,30 +2009,32 @@ The `python` module shows the currently installed version of Python and the curr
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
這個模組在下列其中一個條件達成時顯示： By default the module will be shown if any of the following conditions are met:
- 目前資料夾中有一個 `.python-version` 檔案 - 目前資料夾中有一個 `.python-version` 檔案
- 目前資料夾中有一個 `requirements.txt` 檔案 - The current directory contains a `Pipfile` file
- 目前資料夾中有一個 `pyproject.toml` 檔案
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- 目前資料夾中有一個 `Pipfile` 檔案
- 目前資料夾中有一個 `tox.ini` 檔案
- 現在資料夾中包含一個 `setup.py` 檔案
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `setup.py` file
- The current directory contains a `tox.ini` file
- The current directory contains a file with the `.py` extension.
- A virtual environment is currently activated - A virtual environment is currently activated
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| -------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `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 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | 這個模組的風格。 | | `style` | `"yellow bold"` | 這個模組的風格。 |
| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 | | `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `[".py"]` | Which extensions should trigger this moudle |
| `disabled` | `false` | 停用 `python` 模組。 | | `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. |
::: tip ::: tip
@ -2010,9 +2073,17 @@ pyenv_version_name = true
python_binary = "python3" python_binary = "python3"
``` ```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
## Ruby ## Ruby
`ruby` 模組顯示現在安裝的 Ruby 版本。 這個模組在下列其中一個條件達成時顯示： By default the `ruby` module shows the currently installed version of Ruby. 這個模組在下列其中一個條件達成時顯示：
- 目前資料夾中有一個 `Gemfile` 檔案 - 目前資料夾中有一個 `Gemfile` 檔案
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2020,12 +2091,15 @@ python_binary = "python3"
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | 這個模組的風格。 | | `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
| `disabled` | `false` | 停用 `ruby` 模組。 | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2048,19 +2122,22 @@ symbol = "🔺 "
## Rust ## Rust
`rust` 模組顯示現在安裝的 Rust 版本。 這個模組在下列其中一個條件達成時顯示： By default the `rust` module shows the currently installed version of Rust. 這個模組在下列其中一個條件達成時顯示：
- 目前資料夾中有一個 `Cargo.toml` 檔案 - 目前資料夾中有一個 `Cargo.toml` 檔案
- 現在資料夾中包含一個檔案具有 `.rs` 副檔名 - 現在資料夾中包含一個檔案具有 `.rs` 副檔名
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | 這個模組的風格。 | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `disabled` | `false` | 停用 `rust` 模組。 | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2081,6 +2158,45 @@ symbol = "🔺 "
format = "via [⚙️ $version](red bold)" format = "via [⚙️ $version](red bold)"
``` ```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。
:::
### 選項
| Option | 預設 | 說明 |
| ---------------------- | ------------ | --------------------------------------------- |
| `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `format` | `$indicator` | The format for the module. |
| `disabled` | `true` | Disables the `shell` module. |
### Variables
| 變數 | 預設 | 說明 |
| --------- | -- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
### Examples
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false
```
## SHLVL ## 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.
@ -2208,19 +2324,22 @@ disabled = false
## Swift ## Swift
The `swift` module shows the currently installed version of Swift. 這個模組在下列其中一個條件達成時顯示： By default the `swift` module shows the currently installed version of Swift. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `Package.swift` file - The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | 這個模組的風格。 | | `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. |
| `disabled` | `false` | Disables the `swift` module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 202"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -2251,19 +2370,22 @@ By default the terraform version is not shown, since this is slow for current ve
::: :::
這個模組在下列其中一個條件達成時顯示： By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions - Current directory contains a file with the `.tf` or `.hcl` extensions
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | 這個模組的風格。 | | `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `terraform` module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2298,7 +2420,7 @@ format = "[🏎💨 $workspace]($style) "
## 時間 ## 時間
`time` 模組顯示目前的**當地**時間. `format` 設定值被 [`chrono`](https://crates.io/crates/chrono) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。 The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -2308,23 +2430,23 @@ format = "[🏎💨 $workspace]($style) "
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 啟用 12 小時格式。 | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | 這個模組的時間的風格。 | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | 設定相對於 UTC 的時差。 Range from -24 &lt; x &lt; 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | 停用 `time` 模組。 | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. 不然的話，它會被預設為 `"%T"`。 Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | ---------- | ----------------------------------- | | --------- | ---------- | ----------------------------------- |
| 時間 | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string \*: This variable can only be used as a part of a style string
@ -2342,9 +2464,9 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## 使用者名稱 ## Username
`username` 模組顯示現在使用中的使用者名稱。 這個模組在下列其中一個條件達成時顯示： The `username` module shows active user's username. 這個模組在下列其中一個條件達成時顯示：
- 目前使用者為 root - 目前使用者為 root
- 目前使用者並非登入時的使用者 - 目前使用者並非登入時的使用者
@ -2359,13 +2481,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------- | ----------------------- | -------------------------- | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | 使用者為 root 時使用的風格。 | | `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | 非 root 使用者時使用的風格。 | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | The format for the module. | | `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | 總是顯示 `username` 模組。 | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | 停用 `username` 模組。 | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -2389,18 +2511,21 @@ show_always = true
## Vagrant ## Vagrant
The `vagrant` module shows the currently installed version of Vagrant. 這個模組在下列其中一個條件達成時顯示： The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file - The current directory contains a `Vagrantfile` file
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | --------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `style` | `"cyan bold"` | 這個模組的風格。 | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `disabled` | `false` | Disables the `Vagrant` module. | | `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. |
### Variables ### Variables
@ -2423,18 +2548,21 @@ format = "via [⍱ $version](bold white) "
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. 這個模組在下列其中一個條件達成時顯示： By default the the `zig` module shows the currently installed version of Zig. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | 這個模組的風格。 | | `style` | `"bold yellow"` | 這個模組的風格。 |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Variables ### Variables
@ -2491,7 +2619,7 @@ The order in which custom modules are shown can be individually set by including
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `說明` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

2
docs/zh-TW/guide/README.md
View File

@ -19,7 +19,7 @@
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square" src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
alt="Packaging status" /></a alt="Packaging status" /></a
><br /> ><br />
<a href="https://discord.gg/8Jzqu3T" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="在 Discord 上聊天" /></a> alt="在 Discord 上聊天" /></a>

10
docs/zh-TW/installing/README.md
View File

@ -8,6 +8,16 @@ To install starship, you need to do two things:
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
## [termux](https://termux.com)
### 先決要求
```sh
pkg install getconf
```
### Installation
```sh
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
```
## [Nix](https://nixos.wiki/wiki/Nix) ## [Nix](https://nixos.wiki/wiki/Nix)