mirror of
https://github.com/starship/starship.git
synced 2024-10-05 09:52:50 +02:00
docs(i18n): New Crowdin updates (#2678)
* New translations README.md (Spanish) * 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 (French) * 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 (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (French) * New translations README.md (French) * New translations README.md (French) * New translations README.md (French) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * 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)
This commit is contained in:
Matan Kushner
GitHub
parent
20e10c550f
commit
d0a32b1194
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -2,23 +2,23 @@
|
||||
home: true
|
||||
heroImage: /logo.svg
|
||||
heroText:
|
||||
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
|
||||
actionText: Get Started →
|
||||
tagline: promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک!
|
||||
actionText: دەستپێبکە ←
|
||||
actionLink: ./guide/
|
||||
features:
|
||||
-
|
||||
title: Compatibility First
|
||||
details: Works on the most common shells on the most common operating systems. Use it everywhere!
|
||||
title: سەرەتا گونجان
|
||||
details: کاردەکات لەسەر زۆربەی شێڵە باوەکان لەسەر زۆربەی سیستەمە باوەکان. لە هەموو شوێنێک بەکاری بهێنە!
|
||||
-
|
||||
title: Rust-Powered
|
||||
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
|
||||
title: Rust لە پشتە
|
||||
details: باشترینی هاوتاکانی لە خێرایی و سەلامەتی Rust بەکارئەهێنێ بۆ ئەوەی promptـەکەت خێراترین و پشت پێبەستراوین بێ.
|
||||
-
|
||||
title: Customizable
|
||||
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
|
||||
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
|
||||
title: دڵخوازکراو
|
||||
details: هەموو وردەکارییەکی دڵخواز ئەکرێ بەوجۆرەی حەزت لێیە، بۆ ئەوەی promptـەکە سوکەڵە بێ و پڕ تایبەتمەندی بێت بەوجۆرەی حەزت لێیە ببێ.
|
||||
footer: لەژێر مۆڵەتی ISCـە | مافی پارێزراوە © 2019-ئێستا بەژداریکەرانی Starship
|
||||
#Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship: Cross-Shell Prompt"
|
||||
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, and PowerShell.
|
||||
metaTitle: "Starship: یەکێ لە Promptـە شێڵ نەناسەکان"
|
||||
description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و بێسنور دڵخوازکراوەکان بۆ هەر شێڵێک! ئەو زانیارییانە پشان دەدات کە پێویستە، لەوکاتەیا بە ئارامی و سوکەڵەیی ئەمێنێتەوە. دامەزراندنی خێرا بەردەستە بۆ Bash, Fish, ZSH, Ion و PowerShell.'
|
||||
---
|
||||
|
||||
<div class="center">
|
||||
@ -28,45 +28,45 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
</video>
|
||||
</div>
|
||||
|
||||
### Prerequisites
|
||||
### پێشمەرجەکان
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal.
|
||||
- [فۆنتێکی Nerd](https://www.nerdfonts.com/) دامەزراوە و چالاککراوە لە تێرمیناڵەکەتا.
|
||||
|
||||
### Quick Install
|
||||
### دامەزراندنی خێرا
|
||||
|
||||
1. Install the **starship** binary:
|
||||
1. باینەری **starship** دابمەزرێنە:
|
||||
|
||||
|
||||
#### Install Latest Version
|
||||
#### کۆتا وەشان دابمەزرێنە
|
||||
|
||||
With Shell:
|
||||
لەگەڵ شێڵ:
|
||||
|
||||
```sh
|
||||
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
بۆ نوێکردنەوەی Starship خۆی، نووسینەکەی سەرەوە ڕەن بکەوە. وەشانی ئێستا دەگۆڕێت بێ ئەوەی دەسکاری ڕێکخستنەکانی Starship بکات.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
#### دابمەزرێنە لەڕێگەی بەڕێوبەری گورزەوە
|
||||
|
||||
With [Homebrew](https://brew.sh/):
|
||||
لەگەڵ [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
```
|
||||
|
||||
With [Scoop](https://scoop.sh):
|
||||
لەگەڵ [Scoop](https://scoop.sh):
|
||||
|
||||
```powershell
|
||||
scoop install starship
|
||||
```
|
||||
|
||||
1. Add the init script to your shell's config file:
|
||||
1. نوسینی init زیادبکە بۆ فایلی ڕێکخستنی شێڵەکەت:
|
||||
|
||||
|
||||
#### Bash
|
||||
|
||||
Add the following to the end of `~/.bashrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.bashrc`:
|
||||
|
||||
```sh
|
||||
# ~/.bashrc
|
||||
@ -77,7 +77,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
#### Fish
|
||||
|
||||
Add the following to the end of `~/.config/fish/config.fish`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/fish/config.fish`:
|
||||
|
||||
```sh
|
||||
# ~/.config/fish/config.fish
|
||||
@ -88,7 +88,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
#### Zsh
|
||||
|
||||
Add the following to the end of `~/.zshrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.zshrc`:
|
||||
|
||||
```sh
|
||||
# ~/.zshrc
|
||||
@ -99,7 +99,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
#### Powershell
|
||||
|
||||
Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `Microsoft.PowerShell_profile.ps1`. ئەتوانی شوێنی ئەم فایلە ببینیتەوە بە سەیرکردنی گۆڕاوی `$PROFILE` لە PowerShell. ئاسایی ڕێڕەوەکە بریتیە لە `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` یان `/.config/powershell/Microsoft.PowerShell_profile.ps1` لەسەر -Nix.
|
||||
|
||||
```sh
|
||||
Invoke-Expression (&starship init powershell)
|
||||
@ -108,7 +108,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
#### Ion
|
||||
|
||||
Add the following to the end of `~/.config/ion/initrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/ion/initrc`:
|
||||
|
||||
```sh
|
||||
# ~/.config/ion/initrc
|
||||
@ -118,9 +118,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning Only elvish v0.15 or higher is supported. :::
|
||||
::: ئاگادارکردنەوە تەنها elvish v0.15 یان بەرزتر پشتگیری کراوە. :::
|
||||
|
||||
Add the following to the end of `~/.elvish/rc.elv`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`:
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
@ -131,7 +131,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
||||
|
||||
#### Tcsh
|
||||
|
||||
Add the following to the end of `~/.tcshrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.tcshrc`:
|
||||
|
||||
```sh
|
||||
# ~/.tcshrc
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
# FAQ
|
||||
|
||||
## What is the configuration used in the demo GIF?
|
||||
## ئەو ڕێکخستنە چییە لە GIF پێشاندانەکەدا بەکارهاتووە؟
|
||||
|
||||
- **Terminal Emulator**: [iTerm2](https://iterm2.com/)
|
||||
- **Theme**: Minimal
|
||||
- **Color Scheme**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy)
|
||||
- **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)
|
||||
- **Shell**: [Fish Shell](https://fishshell.com/)
|
||||
- **Configuration**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish)
|
||||
- **ڕووکار**: Minimal
|
||||
- **شێوازی ڕەنگەکان**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy)
|
||||
- **فۆنت**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)
|
||||
- **شێڵ**: [شێڵی Fish](https://fishshell.com/)
|
||||
- **ڕێکخستن**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish)
|
||||
- **Prompt**: [Starship](https://starship.rs/)
|
||||
|
||||
## How do I get command completion as shown in the demo GIF?
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
alt="Starship - یەکێ لە promptـە شێڵ نەناسەکان"
|
||||
/>
|
||||
</p>
|
||||
|
||||
@ -10,36 +10,32 @@
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/workflow/status/starship/starship/Main workflow/master?label=workflow&style=flat-square"
|
||||
alt="GitHub Actions workflow status"
|
||||
alt="دۆخی ڕێڕەوی کارەکان لە GitHub Actions"
|
||||
/></a>
|
||||
<a href="https://crates.io/crates/starship"
|
||||
><img
|
||||
src="https://img.shields.io/crates/v/starship?style=flat-square"
|
||||
alt="Crates.io version"
|
||||
alt="وەشانی Crates.io"
|
||||
/></a>
|
||||
<a href="https://repology.org/project/starship/versions"
|
||||
><img
|
||||
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
|
||||
alt="Packaging status" /></a
|
||||
alt="دۆخی پێچانەوە" /></a
|
||||
><br />
|
||||
<a href="https://discord.gg/starship"
|
||||
><img
|
||||
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
|
||||
alt="Chat on Discord"
|
||||
alt="گفتوگۆ لە Discord"
|
||||
/></a>
|
||||
<a href="https://twitter.com/StarshipPrompt"
|
||||
><img
|
||||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||||
alt="Follow @StarshipPrompt on Twitter"
|
||||
alt="شوێن @StarshipPrompt بکەوە لەسەر تویتەر"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">Website</a>
|
||||
·
|
||||
<a href="#🚀-installation">Installation</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/">Configuration</a>
|
||||
<a href="https://starship.rs">ماڵپەڕ</a> · <a href="#🚀-installation">دامەزراندن</a> · <a href="https://starship.rs/config/">رێکخستن</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@ -119,72 +115,72 @@
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship with iTerm2 and the Snazzy theme"
|
||||
alt="Starship لەگەڵ iTerm2 و ڕووکاری Snazzy"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**The minimal, blazing-fast, and infinitely customizable prompt for any shell!**
|
||||
**promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک!**
|
||||
|
||||
- **Fast:** it's fast – _really really_ fast! 🚀
|
||||
- **Customizable:** configure every aspect of your prompt.
|
||||
- **Universal:** works on any shell, on any operating system.
|
||||
- **Intelligent:** shows relevant information at a glance.
|
||||
- **Feature rich:** support for all your favorite tools.
|
||||
- **Easy:** quick to install – start using it in minutes.
|
||||
- **خێرا:** خێرایە – _زۆر زۆر_ خێرایە! 🚀
|
||||
- **دڵخوازکراو:** هەموو سوچێکی promptـەکەت ڕێکبخە.
|
||||
- **گشتگیر:** لەسەر هەر شێڵێک، هەر سیستەمێک ئیش ئەکات.
|
||||
- **زیرەک:** زانیاری پەیوەندیدار لە چاوتروکانێک نیشان دەدات.
|
||||
- **دەوڵەمەند بە تایبەتمەندی:** پشتگیری هەموو ئامرازە دڵخوازەکانت ئەکات.
|
||||
- **ئاسان:** خێرا لە دامەزراندن – دەست ئەکەیت بە بەکارهێنانی لە چەند خولەکێکدا.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>Explore the Starship docs ▶</strong></a>
|
||||
<a href="https://starship.rs/config/"><strong>بەڵگەنامەکانی Starship بگەڕێ ◀</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
|
||||
## 🚀 Installation
|
||||
## 🚀 دامەزراندن
|
||||
|
||||
### Prerequisites
|
||||
### پێشمەرجەکان
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
|
||||
- فۆنتێکی [Nerd](https://www.nerdfonts.com/) دامەزرابێ و چالاککرابێ لە تێرمیناڵەکەتدا (بۆ نموونە، [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads) تاقی بکەرەوە).
|
||||
|
||||
### Getting Started
|
||||
### دەستپێکردن
|
||||
|
||||
**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/).
|
||||
**تێبینی**: بەهۆی خێرا گۆڕانی سەکۆ جیاوازەکان، تەنها بەشێک لە سەکۆ پشتگیری کراوەکان لە خوارەوە پشاندراون. ناتوانی ئەو سەکۆیە ببینیت کە ئەتەوێ؟ سەیری [ڕێنماییەکانی سەکۆکانی تر](https://starship.rs/installing/) بکە.
|
||||
|
||||
1. Install the **starship** binary:
|
||||
1. باینەری **starship** دابمەزرێنە:
|
||||
|
||||
|
||||
#### Install Latest Version
|
||||
#### کۆتا وەشان دابمەزرێنە
|
||||
|
||||
|
||||
##### From prebuilt binary, with Shell:
|
||||
##### لە باینەرییە پێشوەخت دروستکراوەکانەوە، لەگەڵ شێڵی:
|
||||
|
||||
```sh
|
||||
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
|
||||
```
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
بۆ نوێکردنەوەی Starship خۆی، نووسینەکەی سەرەوە ڕەن بکەوە. وەشانی ئێستا دەگۆڕێت بێ ئەوەی دەسکاری ڕێکخستنەکانی Starship بکات.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
#### دابمەزرێنە لەڕێگەی بەڕێوبەری گورزەوە
|
||||
|
||||
|
||||
##### Example: [Homebrew](https://brew.sh/):
|
||||
##### نموونە: [Homebrew](https://brew.sh/):
|
||||
|
||||
```sh
|
||||
brew install starship
|
||||
```
|
||||
|
||||
|
||||
##### With [Scoop](https://scoop.sh):
|
||||
##### لەگەڵ [Scoop](https://scoop.sh):
|
||||
|
||||
```powershell
|
||||
scoop install starship
|
||||
```
|
||||
|
||||
2. Add the init script to your shell's config file:
|
||||
2. نوسینی init زیادبکە بۆ فایلی ڕێکخستنی شێڵەکەت:
|
||||
|
||||
|
||||
#### Bash
|
||||
|
||||
Add the following to the end of `~/.bashrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.bashrc`:
|
||||
|
||||
```sh
|
||||
# ~/.bashrc
|
||||
@ -195,7 +191,7 @@
|
||||
|
||||
#### Fish
|
||||
|
||||
Add the following to the end of `~/.config/fish/config.fish`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/fish/config.fish`:
|
||||
|
||||
```sh
|
||||
# ~/.config/fish/config.fish
|
||||
@ -206,7 +202,7 @@
|
||||
|
||||
#### Zsh
|
||||
|
||||
Add the following to the end of `~/.zshrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.zshrc`:
|
||||
|
||||
```sh
|
||||
# ~/.zshrc
|
||||
@ -217,7 +213,7 @@
|
||||
|
||||
#### PowerShell
|
||||
|
||||
Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `Microsoft.PowerShell_profile.ps1`. ئەتوانی شوێنی ئەم فایلە ببینیتەوە بە سەیرکردنی گۆڕاوی `$PROFILE` لە PowerShell. ئاسایی ڕێڕەوەکە بریتیە لە `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` یان `/.config/powershell/Microsoft.PowerShell_profile.ps1` لەسەر -Nix.
|
||||
|
||||
```powershell
|
||||
Invoke-Expression (&starship init powershell)
|
||||
@ -226,7 +222,7 @@
|
||||
|
||||
#### Ion
|
||||
|
||||
Add the following to the end of `~/.config/ion/initrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/ion/initrc`:
|
||||
|
||||
```sh
|
||||
# ~/.config/ion/initrc
|
||||
@ -237,7 +233,7 @@
|
||||
|
||||
#### Elvish
|
||||
|
||||
**Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`:
|
||||
**ئاگادارکردنەوە** تەنها elvish v0.15 یان بەرزتر پشتگیری کراوە. ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`:
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
@ -248,7 +244,7 @@
|
||||
|
||||
#### Tcsh
|
||||
|
||||
Add the following to the end of `~/.tcshrc`:
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.tcshrc`:
|
||||
|
||||
```sh
|
||||
# ~/.tcshrc
|
||||
@ -256,30 +252,30 @@
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
## 🤝 Contributing
|
||||
## 🤝 بەژداریکردن
|
||||
|
||||
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||||
ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! ئەگەر بەدوای ئەوەوەی کە بێیتە ئەم پڕۆژەیەوە [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) تاقیبکەرەوە.
|
||||
|
||||
If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/).
|
||||
ئەگەر پاراویت لە زمانێک جگە لە ئینگلیزی، ئێمە زۆر خۆشحاڵدەبین بە هەر یارمەتییەک کە بەڵگەنامەکانمان بە وەرگێڕدراوی بهێڵێتەوە و نوێکراوی بهێڵێتەوە بە زمانەکانی دیکە. ئەگەر نیازت هەیە یارمەتی بدەیت، ئەتوانی بەژداری لە وەرگێڕاندا بکەیت لەسەر [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
|
||||
ئەگەر حەزئەکەیت یارمەتی بدەیت بە بەژداریکردن لە starship، تکایە سەیری [ڕێبەری بەژداریکردن](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)ـەکەمان بکە. هەروەها، شەرم مەکە وەرە نێوە [ڕاژەی Discord](https://discord.gg/8Jzqu3T)ـەکەمانەوە و سڵاوێک بکە. 👋
|
||||
|
||||
### Code Contributors
|
||||
### بەژداریکردن بە کۆد
|
||||
|
||||
This project exists thanks to all the people who contribute. [[Contribute](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)].
|
||||
سوپاس بۆ هەموو ئەو کەسانەی کە بەژدارییان کردووە تا ئەم پڕۆژەیە هەبێت. [[بەژداربە](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)].
|
||||
<a href="https://github.com/starship/starship/graphs/contributors"><img src="https://opencollective.com/starship/contributors.svg?width=890&button=false" /></a>
|
||||
|
||||
### Financial Contributors
|
||||
### بەژداریکەرە داراییەکان
|
||||
|
||||
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/contribute)]
|
||||
ببە بەژداریکەرێکی دارایی و یارمەتیمان بدە بەردەوامبین لە کۆمەڵگەکەماندا. [[بەژداربە](https://opencollective.com/starship/contribute)]
|
||||
|
||||
#### Individuals
|
||||
#### تاکە کەسەکان
|
||||
|
||||
<a href="https://opencollective.com/starship"><img src="https://opencollective.com/starship/individuals.svg?width=890"></a>
|
||||
|
||||
#### Organizations
|
||||
#### ڕێکخراوەکان
|
||||
|
||||
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/starship/contribute)]
|
||||
پشتگیری ئەم پڕۆژەیە بکە لەڕێی ڕێکخراوەکەتەوە. لۆگۆکەت لێرە دەردەکەوێ لەگەڵ بەستەرێک بۆ ماڵپەڕەکەت. [[بەژداربە](https://opencollective.com/starship/contribute)]
|
||||
|
||||
<a href="https://opencollective.com/starship/organization/0/website"><img src="https://opencollective.com/starship/organization/0/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/starship/organization/1/website"><img src="https://opencollective.com/starship/organization/1/avatar.svg"></a>
|
||||
@ -292,21 +288,21 @@ Support this project with your organization. Your logo will show up here with a
|
||||
<a href="https://opencollective.com/starship/organization/8/website"><img src="https://opencollective.com/starship/organization/8/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/starship/organization/9/website"><img src="https://opencollective.com/starship/organization/9/avatar.svg"></a>
|
||||
|
||||
## 💭 Inspired By
|
||||
## 💭 ئیلهامبەخشەکان
|
||||
|
||||
Please check out these previous works that helped inspire the creation of starship. 🙏
|
||||
تکایە ئەم کارە کۆنانە سەیربکەوە کە ئیلهامی دروستکردنی starship دا. 🙏
|
||||
|
||||
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts.
|
||||
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - یەکێ لە promptـەکانی ZSH بۆ ئاسمانەوانان.
|
||||
|
||||
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript.
|
||||
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - ڕووکاری robbyrussellـی شێڵ نەناس کە بە جاڤاسکریپت نووسراوە.
|
||||
|
||||
- **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons.
|
||||
- **[reujab/silver](https://github.com/reujab/silver)** - یەکێ لە promptـە شێڵ نەناسە دڵخوازکراوەکان کە لە powerline دەچێ لەگەڵ ئایکۆندا.
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="ئایکۆنی مووشەکی Starship">
|
||||
</p>
|
||||
|
||||
## 📝 License
|
||||
## 📝 مۆڵەتنامە
|
||||
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.
|
||||
هەموو مافێکی پارێزراوە © 2019-ئێستا، [بەژداریکەرانی Starship](https://github.com/starship/starship/graphs/contributors). <br />ئەم پڕۆژەیە لە ژێر مۆڵەتنامەی [ISC](https://github.com/starship/starship/blob/master/LICENSE)ـە.
|
||||
|
||||
@ -11,7 +11,7 @@ There are so many platforms out there that they didn't fit into the main README.
|
||||
|
||||
## [Chocolatey](https://chocolatey.org)
|
||||
|
||||
### Prerequisites
|
||||
### پێشمەرجەکان
|
||||
|
||||
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
|
||||
|
||||
@ -23,7 +23,7 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### Prerequisites
|
||||
### پێشمەرجەکان
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
|
||||
@ -8,7 +8,7 @@ This preset doesn't change anything except for the symbols used for each module.
|
||||
|
||||
|
||||
|
||||
### Prerequisites
|
||||
### پێشمەرجەکان
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)
|
||||
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
Das `aws`-Modul zeigt das aktuelle AWS-Profil an. Dies basiert auf den Umgebungsvariablen: `AWS_REGION`, `AWS_DEFAULT_REGION`, `AWS_PROFILE` und der `~/.aws/config` Datei.
|
||||
Das `aws`-Modul zeigt das aktuelle AWS-Profil an. Dies basiert auf den Umgebungsvariablen: `AWS_REGION`, `AWS_DEFAULT_REGION`, `AWS_PROFILE` und der `~/.aws/config` Datei. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | Stil für dieses Modul. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | Symbol das vor der dotnet-Version angezeigt wird. |
|
||||
| `heuristic` | `true` | Schnelle Versionserkennung nutzen um Starship bedienbar zu halten. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | Stil für dieses Modul. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | Stil für dieses Modul. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Paketversion
|
||||
|
||||
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | Stil für dieses Modul. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | Stil für dieses Modul. |
|
||||
| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Beispiel
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2813,19 +2852,19 @@ The order in which custom modules are shown can be individually set by including
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| -------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| `shell` | | [See below](#custom-command-shell) |
|
||||
| `beschreibung` | `"<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. |
|
||||
| `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. |
|
||||
| `symbol` | `""` | The symbol used before displaying the command output. |
|
||||
| `style` | `"bold green"` | Stil für dieses Modul. |
|
||||
| `format` | `"[$symbol($output )]($style)"` | The format for the module. |
|
||||
| `disabled` | `false` | Disables this `custom` module. |
|
||||
| Option | Standardwert | Beschreibung |
|
||||
| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| `shell` | | [See below](#custom-command-shell) |
|
||||
| `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. |
|
||||
| `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. |
|
||||
| `symbol` | `""` | The symbol used before displaying the command output. |
|
||||
| `style` | `"bold green"` | Stil für dieses Modul. |
|
||||
| `format` | `"[$symbol($output )]($style)"` | The format for the module. |
|
||||
| `disabled` | `false` | Disables this `custom` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
El módulo `aws` muestra la región y el perfil actual de AWS. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del fichero `~/.aws/config`.
|
||||
El módulo `aws` muestra la región y el perfil actual de AWS. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del fichero `~/.aws/config`. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obtiene de la variable de entorno `AWS_VAULT`.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
Cuando uses [awsu](https://github.com/kreuzwerker/awsu) el perfil se obtiene de la variable de entorno `AWSU_PROFILE`.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ---------------- | --------------------------------------------------- | ------------------------------------------------------------ |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | El formato del módulo. |
|
||||
| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. |
|
||||
| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
|
||||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `aws`. |
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | El formato del módulo. |
|
||||
| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. |
|
||||
| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
|
||||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| --------- | ---------------- | -------------------------------------- |
|
||||
| region | `ap-northeast-1` | La región actual de AWS |
|
||||
| profile | `astronauts` | El perfil actual de AWS |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | La región actual de AWS |
|
||||
| profile | `astronauts` | El perfil actual de AWS |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
|
||||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | El símbolo usado antes de la versión de cmake. |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Qué nombres de archivo deben activar este módulo |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | El estilo del módulo. |
|
||||
| `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart |
|
||||
| `detect_extensions` | `["dart"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | Una cadena de formato que representa el símbolo de Deno |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -793,7 +796,7 @@ El módulo también mostrará el Target Framework Moniker ([https://docs.microso
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | Símbolo usado antes de mostrar la versión de .NET |
|
||||
| `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Qué extensiones deberían activar este módulo. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | El formato para el módulo elixir. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | El símbolo usado antes de mostrar la version de Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["mix.exs"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | Una cadena de formato que representa el símbolo de Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | El símbolo usado antes de mostrar la versión de Erlang. |
|
||||
| `style` | `"bold red"` | El estilo del módulo. |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
|
||||
@ -1095,7 +1098,7 @@ El módulo `git_commit` muestra el hash de la confirmación actual y también la
|
||||
| `style` | `"bold green"` | El estilo del módulo. |
|
||||
| `only_detached` | `true` | Mostrar solo el hash de la confirmación de git cuando esté en estado "detached `HEAD`" |
|
||||
| `tag_disabled` | `true` | Deshabilita mostrar información de etiquetas en el módulo `git_commit`. |
|
||||
| `tag_symbol` | `"🏷 "` | Símbolo de etiqueta prefijando la información mostrada |
|
||||
| `tag_symbol` | `" 🏷 "` | Símbolo de etiqueta prefijando la información mostrada |
|
||||
| `disabled` | `false` | Deshabilita el módulo `git_commit`. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. |
|
||||
| `detect_extensions` | `["go"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | Una cadena de formato que representa el símbolo de Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[".lua-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | El símbolo usado antes de mostrar la versión de Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["nim.cfg"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | La cadena de formato para el módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | El símbolo usado antes de mostrar la versión de OCaml. |
|
||||
| `global_switch_indicator` | `""` | La cadena de formato usada para representar el interruptor global de OPAM. |
|
||||
| `local_switch_indicator` | `"*"` | La cadena de formato usada para representar el interruptor local de OPAM. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Versión del paquete
|
||||
|
||||
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. El módulo soporta actualmente los paquetes `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` y `helm`.
|
||||
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ La versión que se muestra es la del paquete cuyo código fuente está en tu directorio actual, no en tu gestor de paquetes.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Por defecto | Descripción | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. | |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Qué extensiones deberían activar este módulo. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Qué nombres de archivo deberían activar este módulo. | |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | |
|
||||
| `style` | `"bold 149"` | El estilo del módulo. | |
|
||||
| `disabled` | `false` | Desactiva el módulo `perl`. | |
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||||
| `style` | `"bold 149"` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Desactiva el módulo `perl`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | El símbolo usado antes de mostrar la versión de PHP. |
|
||||
| `detect_extensions` | `["php"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["spago.dhall"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2105,7 +2110,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
|
||||
| Opción | Por defecto | Descripción |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | Una cadena de formato que representa el símbolo de Python |
|
||||
| `style` | `"yellow bold"` | El estilo del módulo. |
|
||||
| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust |
|
||||
| `detect_extensions` | `["rs"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[".metals"]` | Qué carpetas deberían activar estos módulos. |
|
||||
@ -2329,18 +2334,18 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ---------------------- | ------------ | ------------------------------------------------------------ |
|
||||
| `bash_indicator` | `bsh` | Una cadena de formato usada para representar Bash. |
|
||||
| `fish_indicator` | `fsh` | Una cadena de formato usada para representar Fish. |
|
||||
| `zsh_indicator` | `zsh` | Una cadena de formato usada para representar Zsh. |
|
||||
| `powershell_indicator` | `psh` | Una cadena de formato usada para representar Powershell. |
|
||||
| `ion_indicator` | `ion` | Una cadena de formato usada para representar Ion. |
|
||||
| `elvish_indicator` | `esh` | Una cadena de formato usada para representar Elvish. |
|
||||
| `tcsh_indicator` | `tsh` | Una cadena de formato usada para representar tcsh. |
|
||||
| `unknown_indicator` | | The default value to be displayed when the shell is unknown. |
|
||||
| `format` | `$indicator` | El formato del módulo. |
|
||||
| `disabled` | `true` | Deshabilita el módulo `shell`. |
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ---------------------- | ------------ | -------------------------------------------------------------------- |
|
||||
| `bash_indicator` | `bsh` | Una cadena de formato usada para representar Bash. |
|
||||
| `fish_indicator` | `fsh` | Una cadena de formato usada para representar Fish. |
|
||||
| `zsh_indicator` | `zsh` | Una cadena de formato usada para representar Zsh. |
|
||||
| `powershell_indicator` | `psh` | Una cadena de formato usada para representar Powershell. |
|
||||
| `ion_indicator` | `ion` | Una cadena de formato usada para representar Ion. |
|
||||
| `elvish_indicator` | `esh` | Una cadena de formato usada para representar Elvish. |
|
||||
| `tcsh_indicator` | `tsh` | Una cadena de formato usada para representar tcsh. |
|
||||
| `unknown_indicator` | | El valor por defecto que se mostrará cuando se desconoce el comando. |
|
||||
| `format` | `$indicator` | El formato del módulo. |
|
||||
| `disabled` | `true` | Deshabilita el módulo `shell`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | Una cadena de formato que representa el símbolo de Swift |
|
||||
| `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2544,7 +2549,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | Una cadena de formato que se muestra antes del espacio de trabajo de terraform. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | Una cadena de formato que representa el símbolo de Vagrant. |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
@ -2712,26 +2717,60 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
## VLang
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. El módulo sólo se mostrará si un repositorio está actualmente en uso.
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ---------- | -------------------------------- | ------------------------------------------------------------ |
|
||||
| `symbol` | | El símbolo usado antes de mostrar el nombre del repositorio. |
|
||||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||||
| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `vcsh`. |
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | -------------------------------------------- | ---------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||||
| `style` | `"blue bold"` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| ----------- | ----------------------------------------------------------- | -------------------------------------- |
|
||||
| repositorio | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| --------- | ------- | -------------------------------------- |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
|
||||
### Ejemplo
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ---------- | -------------------------------- | ------------------------------------------------------ |
|
||||
| `symbol` | | The symbol used before displaying the repository name. |
|
||||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||||
| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. |
|
||||
| `disabled` | `false` | Disables the `vcsh` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| --------- | ------------------------------------------- | -------------------------------------- |
|
||||
| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
|
||||
|
||||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||||
|
||||
@ -2748,17 +2787,17 @@ format = "[🆅 $repo](bold blue) "
|
||||
|
||||
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen:
|
||||
|
||||
- El directorio actual contiene un archivo `.zig`
|
||||
- The current directory contains a `.zig` file
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
|
||||
| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | El símbolo usado antes de mostrar la versión de Zig. |
|
||||
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `zig`. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
| `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||||
@ -2767,7 +2806,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| --------- | -------- | -------------------------------------- |
|
||||
| version | `v0.6.0` | La versión de `zig` |
|
||||
| version | `v0.6.0` | The version of `zig` |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
|
||||
@ -2782,87 +2821,87 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
symbol = "⚡️ "
|
||||
```
|
||||
|
||||
## Comandos personalizados
|
||||
## Custom commands
|
||||
|
||||
Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios.
|
||||
The `custom` modules show the output of some arbitrary commands.
|
||||
|
||||
Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones:
|
||||
These modules will be shown if any of the following conditions are met:
|
||||
|
||||
- El directorio actual contiene un archivo cuyo nombre está en `files`
|
||||
- El directorio actual contiene un directorio cuyo nombre está en `directories`
|
||||
- El directorio actual contiene un archivo cuya extensión está en `extensions`
|
||||
- El comando `when` devuelve 0
|
||||
- The current directory contains a file whose name is in `files`
|
||||
- The current directory contains a directory whose name is in `directories`
|
||||
- The current directory contains a file whose extension is in `extensions`
|
||||
- The `when` command returns 0
|
||||
|
||||
::: consejo
|
||||
|
||||
Múltiples módulos personalizados pueden definirse usando una `.`.
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
:::
|
||||
|
||||
::: consejo
|
||||
|
||||
El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `custom` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos.
|
||||
The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined.
|
||||
|
||||
:::
|
||||
|
||||
::: consejo
|
||||
|
||||
[El issue #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. Si tiene un ejemplo interesante no cubierto allí, no dude en compartirlo allí!
|
||||
[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
|
||||
|
||||
:::
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `command` | | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. |
|
||||
| `when` | | Comando de shell usado como condición para mostrar el módulo. El módulo se mostrará si el comando devuelve un código de estado `0`. |
|
||||
| `shell` | | [Ver abajo](#custom-command-shell) |
|
||||
| `description` | `"<custom module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. |
|
||||
| `files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. |
|
||||
| `directories` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. |
|
||||
| `extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. |
|
||||
| `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. |
|
||||
| `style` | `"bold green"` | El estilo del módulo. |
|
||||
| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. |
|
||||
| `disabled` | `false` | Deshabilita este `módulo` personalizado. |
|
||||
| Opción | Por defecto | Descripción |
|
||||
| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| `shell` | | [See below](#custom-command-shell) |
|
||||
| `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. |
|
||||
| `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. |
|
||||
| `symbol` | `""` | The symbol used before displaying the command output. |
|
||||
| `style` | `"bold green"` | El estilo del módulo. |
|
||||
| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. |
|
||||
| `disabled` | `false` | Disables this `custom` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Descripción |
|
||||
| --------- | ----------------------------------------- |
|
||||
| output | La salida del comando de shell en `shell` |
|
||||
| symbol | Refleja el valor de la opción `symbol` |
|
||||
| style\* | Refleja el valor de la opción `style` |
|
||||
| Variable | Descripción |
|
||||
| --------- | -------------------------------------- |
|
||||
| output | The output of shell command in `shell` |
|
||||
| symbol | Refleja el valor de la opción `symbol` |
|
||||
| style\* | Refleja el valor de la opción `style` |
|
||||
|
||||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||||
|
||||
#### Comando personalizado del intérprete de comandos
|
||||
|
||||
`shell` acepta una lista no vacía de cadenas, donde:
|
||||
`shell` accepts a non-empty list of strings, where:
|
||||
|
||||
- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando.
|
||||
- Otros argumentos siguientes que son pasados al shell.
|
||||
- The first string is the path to the shell to use to execute the command.
|
||||
- Other following arguments are passed to the shell.
|
||||
|
||||
Si no está activado, se retornará a STARSHIP_SHELL y luego a "sh" en Linux, y "cmd /C" en Windows.
|
||||
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
|
||||
|
||||
El `comando` será pasado en stdin.
|
||||
The `command` will be passed in on stdin.
|
||||
|
||||
Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete, p.ej.
|
||||
If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
|
||||
|
||||
```toml
|
||||
shell = ["pwsh", "-Command", "-"]
|
||||
```
|
||||
|
||||
::: advertencia Asegúrate de que tu configuración personalizada de shell salga con éxito
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
Si establece un comando personalizado, asegúrese de que el Shell por defecto usado por starship ejecutará correctamente el comando con una salida elgante (a través de la opción `shell`).
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a starchip a un bucle recursivo donde el shell podría intentar cargar un entorno de perfil completo con starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito.
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros shells para evitar tiempo extra de carga de un perfil personalizado en cada invocación de starship.
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
La detección automática de intérpretes de comandos y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los intérpretes de comandos estén cubiertos. Por favor, [abre un issue](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario.
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
|
||||
@ -2872,8 +2911,8 @@ La detección automática de intérpretes de comandos y la adición adecuada de
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[custom.foo]
|
||||
command = "echo foo" # muestra la salida del comando
|
||||
files = ["foo"] # se pueden especificar filtros
|
||||
command = "echo foo" # shows output of command
|
||||
files = ["foo"] # can specify filters
|
||||
when = """ test "$HOME" == "$PWD" """
|
||||
format = " transcending [$output]($style)"
|
||||
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
Le module `aws` affiche la région et le profil AWS courant. Ces informations sont basées sur les variables d'environnement `AWS_REGION`, `AWS_DEFAULT_REGION`, et `AWS_PROFILE` ainsi que le fichier `~/.aws/config`.
|
||||
Le module `aws` affiche la région et le profil AWS courant. Ces informations sont basées sur les variables d'environnement `AWS_REGION`, `AWS_DEFAULT_REGION`, et `AWS_PROFILE` ainsi que le fichier `~/.aws/config`. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
Quand [aws-vault](https://github.com/99designs/aws-vault) est utilisé, la valeur du profil est lu dans la variable d'environnement: `AWS_VAULT`.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
Lorsque vous utilisez [awsu](https://github.com/kreuzwerker/awsu) le profil est lu depuis la variable d'environnement `AWSU_PROFILE`.
|
||||
|
||||
Lorsque vous utilisez [AWSume](https://awsu.me) le profil est lu depuis la variable d'environnement `AWSUME_PROFILE`.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | Format du module. |
|
||||
| `symbol` | `"☁️ "` | Le symbole affiché avant le profil AWS actuel. |
|
||||
| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `aws`. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format du module. |
|
||||
| `symbol` | `"☁️ "` | Le symbole affiché avant le profil AWS actuel. |
|
||||
| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ---------------- | -------------------------------------- |
|
||||
| region | `ap-northeast-1` | La région AWS actuelle |
|
||||
| profile | `astronauts` | Le profil AWS actuel |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | La région AWS actuelle |
|
||||
| profile | `astronauts` | Le profil AWS actuel |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| 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
|
||||
|
||||
@ -384,7 +387,7 @@ Le caractère vous dira si la dernière commande a été réussie ou pas. Il y a
|
||||
- changement de couleur (`red`/`green`)
|
||||
- changement de forme (`❯`/`✖`)
|
||||
|
||||
Par défaut, seule la couleur change. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
Par défaut, seule la couleur change. Si vous désirez également changer sa forme, jetez un œil à [cet exemple](#with-custom-error-shape).
|
||||
|
||||
::: warning `error_symbol` n'est pas supporté avec elvish. :::
|
||||
|
||||
@ -444,16 +447,16 @@ Le module `cmake` affiche la version actuellement installée de [CMake](https://
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Quels fichiers devraient activer ce module |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `cmake`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Quels fichiers devraient activer ce module |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `cmake`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -563,16 +566,16 @@ Le module `crystal` affiche la version actuellement installée de [Crystal](http
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `detect_extensions` | `["cr"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["shard.yml"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `disabled` | `false` | Désactive le module `crystal`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `detect_extensions` | `["cr"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["shard.yml"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `disabled` | `false` | Désactive le module `crystal`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -603,16 +606,16 @@ Le module `dart` affiche la version actuellement installée de [Dart](https://da
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart |
|
||||
| `detect_extensions` | `["dart"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[".dart_tool"]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `dart`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart |
|
||||
| `detect_extensions` | `["dart"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[".dart_tool"]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `dart`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -640,16 +643,16 @@ Le module `deno` affiche la version actuellement installée de [Deno](https://de
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | Une chaîne de caractères représentant le symbole de Deno |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"green bold"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `deno`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | Une chaîne de caractères représentant le symbole de Deno |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"green bold"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `deno`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -768,7 +771,7 @@ format = "via [🐋 $context](blue bold)"
|
||||
|
||||
## Dotnet
|
||||
|
||||
The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Si le SDK a été épinglé dans le répertoire courant, la version épinglée est affichée. Sinon, le module affiche la dernière version installée du SDK.
|
||||
Le module `dotnet` montre la version pertinente du [SDK .NET Core](https://dotnet.microsoft.com/) pour le répertoire courant. Si le SDK a été épinglé dans le répertoire courant, la version épinglée est affichée. Sinon, le module affiche la dernière version installée du SDK.
|
||||
|
||||
Par défaut, ce module ne sera affiché dans votre invite que lorsqu'un ou plusieurs des fichiers suivants sont présents dans le répertoire courant :
|
||||
|
||||
@ -790,17 +793,17 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | Le symbole utilisé avant d'afficher la version de dotnet. |
|
||||
| `heuristic` | `true` | Utilisez la détection de versions plus rapide pour garder starship instantané. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `dotnet`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Format du module. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | Le symbole utilisé avant d'afficher la version de dotnet. |
|
||||
| `heuristic` | `true` | Utilisez la détection de versions plus rapide pour garder starship instantané. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `dotnet`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -826,22 +829,22 @@ heuristic = false
|
||||
|
||||
## Elixir
|
||||
|
||||
The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
|
||||
Le module `elixir` montre la version actuellement installée de [Elixir](https://elixir-lang.org/) et [Erlang/OTP](https://erlang.org/doc/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
|
||||
|
||||
- Le répertoire courant contient un fichier `mix.exs`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | Format du module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | Le symbole utilisé avant d'afficher la version d'Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["mix.exs"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"bold purple"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `elixir`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | Format du module elixir. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | Le symbole utilisé avant d'afficher la version d'Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["mix.exs"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"bold purple"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `elixir`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -865,7 +868,7 @@ symbol = "🔮 "
|
||||
|
||||
## Elm
|
||||
|
||||
The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
|
||||
Le module `elm` montre la version actuellement installée de [Elm](https://elm-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
|
||||
|
||||
- Le répertoire courant contient un fichier `elm.json`
|
||||
- Le répertoire courant contient un fichier `elm-package.json`
|
||||
@ -875,16 +878,16 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | Une chaîne de format représentant le symbole d'Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `["elm-stuff"]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"cyan bold"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `elm`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | Une chaîne de format représentant le symbole d'Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `["elm-stuff"]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"cyan bold"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `elm`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -914,21 +917,21 @@ Le module `env_var` affiche la valeur actuelle d'une variable d'environnement s
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
|
||||
| `symbol` | | The symbol used before displaying the variable value. |
|
||||
| `variable` | | The environment variable to be displayed. |
|
||||
| `default` | | The default value to be displayed when the selected variable is not defined. |
|
||||
| `format` | `"with [$env_value]($style) "` | Format du module. |
|
||||
| `disabled` | `false` | Disables the `env_var` module. |
|
||||
| Option | Défaut | Description |
|
||||
| ---------- | ------------------------------ | ----------------------------------------------------------------------------------- |
|
||||
| `symbol` | | Le symbole utilisé avant d'afficher la valeur de la variable. |
|
||||
| `variable` | | La variable d'environnement à afficher. |
|
||||
| `default` | | La valeur par défaut à afficher lorsque la variable sélectionnée n'est pas définie. |
|
||||
| `format` | `"with [$env_value]($style) "` | Format du module. |
|
||||
| `disabled` | `false` | Désactive le module `env_var`. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ------------------------------------------- | ------------------------------------------ |
|
||||
| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` |
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ---------------------------------------- | ------------------------------------------------ |
|
||||
| env_value | `Windows NT` (si _variable_ était `$OS`) | La valeur d'environnement de l'option `variable` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` |
|
||||
|
||||
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
|
||||
|
||||
@ -944,29 +947,29 @@ default = "unknown shell"
|
||||
|
||||
## Erlang
|
||||
|
||||
The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
|
||||
Le module `erlang` montre la version actuellement installée de [Erlang/OTP](https://erlang.org/doc/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
|
||||
|
||||
- Le répertoire courant contient un fichier `rebar.config`.
|
||||
- Le répertoire courant contient un fichier `erlang.mk`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["rebar.config", "elang.mk"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `disabled` | `false` | Disables the `erlang` module. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | Le symbole utilisé avant d'afficher la version d'erlang. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["rebar.config", "elang.mk"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `disabled` | `false` | Désactive le module `erlang`. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | --------- | -------------------------------------- |
|
||||
| version | `v22.1.3` | The version of `erlang` |
|
||||
| version | `v22.1.3` | La version d'`erlang` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
@ -983,35 +986,35 @@ format = "via [e $version](bold red) "
|
||||
|
||||
## Google Cloud (`gcloud`)
|
||||
|
||||
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
|
||||
Le module `gcloud` affiche la configuration actuelle pour [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. Ceci est basé sur les fichiers `~/.config/gcloud/active_config` et `~/.config/gcloud/configurations/config_{CONFIG NAME}` et la variable d'environnement `CLOUDSDK_CONFIG`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ---------------- | ---------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format du module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the GCP name. |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `gcloud` module. |
|
||||
| Option | Défaut | Description |
|
||||
| ---------------- | ---------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format du module. |
|
||||
| `symbol` | `"☁️ "` | Le symbole affiché avant le profil GCP actuel. |
|
||||
| `region_aliases` | | Table des alias de région à afficher en plus du nom du GCP. |
|
||||
| `style` | `"bold blue"` | Le style du module. |
|
||||
| `disabled` | `false` | Désactive le module `gcloud`. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ------------- | ------------------------------------------------------------------ |
|
||||
| region | `us-central1` | The current GCP region |
|
||||
| account | `foo` | The current GCP profile |
|
||||
| domain | `example.com` | The current GCP profile domain |
|
||||
| project | | The current GCP project |
|
||||
| active | `default` | The active config name written in `~/.config/gcloud/active_config` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ------------- | ----------------------------------------------------------------------------- |
|
||||
| region | `us-central1` | La région GCP actuelle |
|
||||
| account | `foo` | Le profil GCP actuel |
|
||||
| domain | `exemple.com` | Le domaine du profil GCP actuel |
|
||||
| project | | Le projet GCP actuel |
|
||||
| active | `default` | Le nom de la configuration active écrit dans `~/.config/gcloud/active_config` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| 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
|
||||
|
||||
### Exemples
|
||||
|
||||
#### Display account and project
|
||||
#### Afficher le compte et le projet
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@ -1020,7 +1023,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
|
||||
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
|
||||
```
|
||||
|
||||
#### Display active config name only
|
||||
#### Afficher uniquement le nom de la configuration active
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@ -1030,7 +1033,7 @@ format = "[$symbol$active]($style) "
|
||||
style = "bold yellow"
|
||||
```
|
||||
|
||||
#### Display account and aliased region
|
||||
#### Afficher le compte et la région aliasée
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@ -1042,32 +1045,32 @@ us-central1 = "uc1"
|
||||
asia-northeast1 = "an1"
|
||||
```
|
||||
|
||||
## Git Branch
|
||||
## Branche Git
|
||||
|
||||
The `git_branch` module shows the active branch of the repo in your current directory.
|
||||
Le module `git_branch` affiche la branche active du dépôt dans votre répertoire courant.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | Format du module. Use `"$branch"` to refer to the current branch name. |
|
||||
| `symbol` | `" "` | A format string representing the symbol of git branch. |
|
||||
| `style` | `"bold purple"` | Le style du module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `always_show_remote` | `false` | Affiche le nom de la branche suivie distante, même si elle est égale au nom de la branche locale. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | Format du module. Utilisez `"$branch"` pour vous référer au nom de la branche courante. |
|
||||
| `symbol` | `" "` | Une chaîne de format représentant le symbole de la branche git. |
|
||||
| `style` | `"bold purple"` | Le style du module. |
|
||||
| `truncation_length` | `2^63 - 1` | Tronque une branche git à `N` graphèmes. |
|
||||
| `truncation_symbol` | `"…"` | Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. Vous pouvez utiliser `""` pour ne pas afficher de symbole. |
|
||||
| `only_attached` | `false` | Ne montrer le nom de la branche que si elle n'est pas dans un état `HEAD` détachée. |
|
||||
| `disabled` | `false` | Désactive le module `git_branch`. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
|
||||
| remote_name | `origin` | The remote name. |
|
||||
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
| Variable | Exemple | Description |
|
||||
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| branch | `master` | Le nom de la branche actuelle, par défaut à `HEAD` s'il n'y a pas de branche actuelle (par exemple `HEAD` détachée). |
|
||||
| remote_name | `origin` | Le nom du dépôt distant. |
|
||||
| remote_branch | `master` | Le nom de la branche suivie sur `remote_name`. |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| 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
|
||||
|
||||
@ -1084,25 +1087,25 @@ truncation_symbol = ""
|
||||
|
||||
## Commit Git
|
||||
|
||||
The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
|
||||
Le module `git_commit` affiche le hash du commit actuel ainsi que le tag (le cas échéant) du dépôt dans votre répertoire courant.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Format du module. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `commit_hash_length` | `7` | La longueur du hash affiché du commit git. |
|
||||
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Format du module. |
|
||||
| `style` | `"bold green"` | Le style du module. |
|
||||
| `only_detached` | `true` | Ne montrer le hash du commit qu'en mode `HEAD` détachée. |
|
||||
| `tag_disabled` | `true` | Désactive l'affichage des informations du tag dans le module `git_commit`. |
|
||||
| `tag_symbol` | `" 🏷 "` | Symbole préfixant les informations affichées concernant le tag |
|
||||
| `disabled` | `false` | Désactive le module `git_commit`. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | --------- | ------------------------------------- |
|
||||
| hash | `b703eb3` | The current git commit hash |
|
||||
| hash | `b703eb3` | Le hash du commit git actuel |
|
||||
| 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
|
||||
@ -1117,32 +1120,32 @@ commit_hash_length = 4
|
||||
tag_symbol = "🔖 "
|
||||
```
|
||||
|
||||
## Git State
|
||||
## État Git
|
||||
|
||||
The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
|
||||
Le module `git_state` s'affichera dans les répertoires qui font partie d'un dépôt git, dans lesquels une opération est en cours, comme : _REBASING_, _BISECTING_, etc. S'il y a des informations de progression (par exemple, REBASING 3/10), ces informations seront également affichées.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. |
|
||||
| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. |
|
||||
| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. |
|
||||
| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. |
|
||||
| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. |
|
||||
| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |
|
||||
| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format du module. |
|
||||
| `disabled` | `false` | Disables the `git_state` module. |
|
||||
| Option | Défaut | Description |
|
||||
| -------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rebase` | `"REBASING"` | Une chaîne de format affichée lorsqu'un `rebase` est en cours. |
|
||||
| `merge` | `"MERGING"` | Une chaîne de format affichée quand un `merge` est en cours. |
|
||||
| `revert` | `"REVERTING"` | Une chaîne de format affichée quand un `revert` est en cours. |
|
||||
| `cherry_pick` | `"CHERRY-PICKING"` | Une chaîne de format affichée quand un `cherry-pick` est en cours. |
|
||||
| `bisect` | `"BISECTING"` | Une chaîne de format affichée quand un `bisect` est en cours. |
|
||||
| `am` | `"AM"` | Une chaîne de format affichée lorsqu'un `apply-mailbox` (`git am`) est en cours. |
|
||||
| `am_or_rebase` | `"AM/REBASE"` | Une chaîne de format affichée lorsqu'une `apply-mailbox` ou un `rebase` est en cours sans pouvoir les différencier. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format du module. |
|
||||
| `disabled` | `false` | Désactive le module `git_state`. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| ---------------- | ---------- | ------------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| state | `REBASING` | L'état actuel du dépôt |
|
||||
| progress_current | `1` | Progression de l'opération en cours |
|
||||
| progress_total | `2` | Progression maximale de l'opération |
|
||||
| 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
|
||||
@ -1159,7 +1162,7 @@ cherry_pick = "[🍒 PICKING](bold red)"
|
||||
|
||||
## Statut Git
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
Le module `git_status` affiche des symboles représentant l'état du dépôt dans votre répertoire courant.
|
||||
|
||||
### Options
|
||||
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `[]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `[".lua-version"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -1687,7 +1690,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
|
||||
| `style` | `"bold purple"` | Le style du module. |
|
||||
| `format` | `"on [$symbol$branch]($style) "` | Format du module. |
|
||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
|
||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||
| `truncation_symbol` | `"…"` | Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. |
|
||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||
|
||||
### Variables
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Défaut | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Quelles extensions devraient activer ce module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Quels fichiers devraient activer ce module. | |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | |
|
||||
| `style` | `"bold 149"` | Le style du module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"bold 149"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2105,7 +2110,7 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es
|
||||
| Option | Défaut | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | Le style du module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `[]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[".metals"]` | Quels dossiers devraient activer ce module. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["Package.swift"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2544,7 +2549,7 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `[]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Quels fichiers devraient activer ce module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------------- | ----------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Quelles extensions devraient activer ce module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quels fichiers devraient activer ce module. |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. |
|
||||
| `style` | `"blue bold"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | ------- | -------------------------------------- |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
### Exemple
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Format du module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | Le style du module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2839,9 +2878,9 @@ The order in which custom modules are shown can be individually set by including
|
||||
|
||||
#### 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.
|
||||
- The first string is the path to the shell to use to execute the command.
|
||||
- Other following arguments are passed to the shell.
|
||||
|
||||
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -14,7 +14,7 @@ add_newline = true
|
||||
|
||||
# "❯" 記号を "➜" 記号に置き換えます
|
||||
[character] # 設定しようとしているモジュールの名前は "character" です。
|
||||
success_symbol = "[➜](bold green)" # "success_symbol" セグメントが「太字の緑色」スタイルの "➜"に設定されています
|
||||
success_symbol = "[➜](bold green)" # "success_symbol" セグメントが「太字の緑色」スタイルの "➜" に設定されています
|
||||
|
||||
# packageモジュールを無効にし、プロンプトから完全に隠します
|
||||
[package]
|
||||
@ -27,7 +27,7 @@ disabled = true
|
||||
export STARSHIP_CONFIG=~/.starship/config.toml
|
||||
```
|
||||
|
||||
PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。
|
||||
PowerShell (Windows) で同様に `$PROFILE` にこの行を追加します。
|
||||
|
||||
```powershell
|
||||
$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
|
||||
@ -41,7 +41,7 @@ $ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
|
||||
export STARSHIP_CACHE=~/.starship/cache
|
||||
```
|
||||
|
||||
PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。
|
||||
PowerShell (Windows) で同様に `$PROFILE` にこの行を追加します。
|
||||
|
||||
```powershell
|
||||
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
|
||||
@ -49,11 +49,11 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
|
||||
|
||||
### 用語
|
||||
|
||||
**モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.
|
||||
**モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 例えば、現在のディレクトリが Node.js のプロジェクトの場合、現在コンピュータにインストールされている Node.js のバージョンが表示されます。
|
||||
|
||||
**変数**: モジュールが提供する情報を含むサブコンポーネントを小さくする。 For example, the "version" variable in the "nodejs" module contains the current version of Node.js.
|
||||
**変数**: モジュールが提供する情報を含むサブコンポーネントを小さくする。 例えば、"nodejs" モジュールの "version" 変数には、Node.js の現在のバージョンが含まれています。
|
||||
|
||||
慣例により、ほとんどのモジュールにはデフォルトの端末色の接頭辞（「nodejs」の`via` など）と接尾辞として空のスペースがあります。
|
||||
慣例により、ほとんどのモジュールにはデフォルトの端末色の接頭辞（"nodejs" の `via` など）と接尾辞として空のスペースがあります。
|
||||
|
||||
### 文字列のフォーマット
|
||||
|
||||
@ -142,12 +142,12 @@ format = '''
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ----------------- | ------------------------------ | ------------------------------------------------------------ |
|
||||
| `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 |
|
||||
| `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 |
|
||||
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
|
||||
| `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ----------------- | ------------------------------ | ------------------------------------------------- |
|
||||
| `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 |
|
||||
| `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 |
|
||||
| `command_timeout` | `500` | Starshipによって実行されたコマンドのタイムアウト時間 (milliseconds) です。 |
|
||||
| `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 |
|
||||
|
||||
### 設定例
|
||||
|
||||
@ -215,6 +215,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -239,32 +240,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
`aws` モジュールは現在のAWSプロファイルが表示されます。 これは `~/.aws/config` に記述されている `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境変数に基づいています。
|
||||
`aws` モジュールは現在のAWSプロファイルが表示されます。 これは `~/.aws/config` に記述されている `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境変数に基づいています。 This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
[aws-vault](https://github.com/99designs/aws-vault)を使用する場合、プロファイル は`AWS_VAULT`env varから読み取られます。
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
[awsu](https://github.com/kreuzwerker/awsu) を使う場合、そのプロファイルは環境変数 `AWSU_PROFILE` から読まれます。
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ---------------- | --------------------------------------------------- | ----------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
|
||||
| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | `aws` モジュールを無効にします。 |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
|
||||
| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ---------------- | ---------------------- |
|
||||
| region | `ap-northeast-1` | 現在のAWSリージョン |
|
||||
| profile | `astronauts` | 現在のAWSプロファイル |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | 現在のAWSリージョン |
|
||||
| profile | `astronauts` | 現在のAWSプロファイル |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
\*: この変数はスタイル文字列の一部としてのみ使用できます
|
||||
|
||||
@ -448,7 +451,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | cmakeのバージョンの前に使用される記号 |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -568,7 +571,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | モジュールのスタイルです。 |
|
||||
| `detect_extensions` | `["cr"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["shard.yml"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -607,7 +610,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | Dartのシンボルを表すフォーマット文字列 |
|
||||
| `detect_extensions` | `["dart"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -644,7 +647,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | Dart のシンボルを表すフォーマット文字列 |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -794,7 +797,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | dotnetのバージョンを表示する前に使用される記号です。 |
|
||||
| `heuristic` | `true` | より高速なバージョン検出を使用して、starshipの動作を維持します。 |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
@ -836,7 +839,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["mix.exs"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -879,7 +882,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -906,7 +909,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
format = "via [ $version](cyan bold) "
|
||||
```
|
||||
|
||||
## Environment Variable
|
||||
## 環境変数
|
||||
|
||||
`env_var`モジュールは、選択された環境変数の現在の値を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
|
||||
@ -955,7 +958,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | モジュールのスタイルです。 |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
@ -1043,7 +1046,7 @@ us-central1 = "uc1"
|
||||
asia-northeast1 = "an1"
|
||||
```
|
||||
|
||||
## Git ブランチ
|
||||
## Git Branch
|
||||
|
||||
`git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。
|
||||
|
||||
@ -1096,7 +1099,7 @@ truncation_symbol = ""
|
||||
| `style` | `"bold green"` | モジュールのスタイルです。 |
|
||||
| `only_detached` | `true` | detached `HEAD` 状態のときのみ git コミットハッシュを表示する |
|
||||
| `tag_disabled` | `true` | `git_commit` モジュールのタグ情報の表示を無効にする。 |
|
||||
| `tag_symbol` | `"🏷 "` | 表示される情報の前に追加されるタグシンボル |
|
||||
| `tag_symbol` | `" 🏷 "` | 表示される情報の前に追加されるタグシンボル |
|
||||
| `disabled` | `false` | `git_commit` モジュールを無効にします。 |
|
||||
|
||||
### 変数
|
||||
@ -1259,7 +1262,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -1298,7 +1301,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
@ -1372,7 +1375,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
@ -1452,7 +1455,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
@ -1490,7 +1493,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
@ -1601,7 +1604,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[".lua-version"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -1629,16 +1632,15 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
format = "via [🌕 $version](bold blue) "
|
||||
```
|
||||
|
||||
## Memory Usage
|
||||
## メモリ使用量
|
||||
|
||||
`memory_usage</ 0>モジュールは、現在のシステムメモリとスワップ使用量を示します。</p>
|
||||
`memory_usage` モジュールは、現在のシステムメモリとスワップ使用量を示します。
|
||||
|
||||
<p spaces-before="0">デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。</p>
|
||||
デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。
|
||||
|
||||
<p spaces-before="0">::: tip</p>
|
||||
::: tip
|
||||
|
||||
<p spaces-before="0">このモジュールはデフォルトで無効になっています。
|
||||
有効にするには、設定ファイルで<code>disabled`を`false`に設定します。
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。
|
||||
|
||||
:::
|
||||
|
||||
@ -1677,7 +1679,7 @@ symbol = " "
|
||||
style = "bold dimmed green"
|
||||
```
|
||||
|
||||
## Mercurial ブランチ
|
||||
## Mercurial Branch
|
||||
|
||||
` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。
|
||||
|
||||
@ -1727,7 +1729,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["nim.cfg"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -1809,7 +1811,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -1853,7 +1855,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1921,10 +1923,11 @@ symbol = "☁️ "
|
||||
|
||||
## パッケージのバージョン
|
||||
|
||||
`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1933,6 +1936,7 @@ symbol = "☁️ "
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。
|
||||
|
||||
@ -1977,16 +1981,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | どの拡張子がこのモジュールをアクティブにするか | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | どのファイル名がこのモジュールをアクティブにするか | |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | |
|
||||
| `style` | `"bold 149"` | モジュールのスタイルです。 | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `style` | `"bold 149"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
@ -2018,7 +2022,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 |
|
||||
| `detect_extensions` | `["php"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2057,7 +2061,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["spago.dhall"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2107,7 +2111,7 @@ The `python` module shows the currently installed version of [Python](https://ww
|
||||
| オプション | デフォルト | 説明 |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | モジュールのスタイルです。 |
|
||||
| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します |
|
||||
@ -2173,7 +2177,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2213,7 +2217,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2252,7 +2256,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["Cargo.toml"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2292,7 +2296,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[".metals"]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
@ -2499,7 +2503,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["Package.swift"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2546,7 +2550,7 @@ By default the Terraform version is not shown, since this is slow for current ve
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2687,7 +2691,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["Vagrantfile"]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@ -2714,6 +2718,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `style` | `"blue bold"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ------ | ---------------------- |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | オプション `記号` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
### 設定例
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2757,7 +2795,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2819,8 +2857,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. |
|
||||
| `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) |
|
||||
| `説明` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
|
||||
| `shell` | | [See below](#custom-command-shell) |
|
||||
| `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. |
|
||||
| `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. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variável | Exemplo | Descrição |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variável | Exemplo | Descrição |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | O estilo do módulo. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | O estilo do módulo. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | O estilo do módulo. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | O estilo do módulo. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Padrão | Descrição |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | O estilo do módulo. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Opções
|
||||
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variável | Exemplo | Descrição |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Exemplo
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Padrão | Descrição |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | O estilo do módulo. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2818,7 +2857,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. |
|
||||
| `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) |
|
||||
| `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. |
|
||||
| `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. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
Модуль `aws` показывает текущий регион и профиль AWS. Основано на `AWS_REGION`, `AWS_DEFAULT_REGION`, и `AWS_PROFILE` переменных окружения и файле`~/.aws/config`.
|
||||
Модуль `aws` показывает текущий регион и профиль AWS. Основано на `AWS_REGION`, `AWS_DEFAULT_REGION`, и `AWS_PROFILE` переменных окружения и файле`~/.aws/config`. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
При использовании [aws-vault](https://github.com/99designs/aws-vault) профиль читается из переменной среды `AWS_VAULT`.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ---------------- | --------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | Формат модуля. |
|
||||
| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. |
|
||||
| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Формат модуля. |
|
||||
| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. |
|
||||
| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------- | ---------------- | ------------------------------------ |
|
||||
| регион | `ap-northeast-1` | Текущий регион AWS |
|
||||
| профиль | `astronauts` | Текущий профиль AWS |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------- | ---------------- | ------------------------------------------- |
|
||||
| регион | `ap-northeast-1` | Текущий регион AWS |
|
||||
| профиль | `astronauts` | Текущий профиль AWS |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
|
||||
\*: Эта переменная может использоваться только в качестве части строки style
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | Стиль модуля. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | Символ перед отображением текущей версии dotnet. |
|
||||
| `heuristic` | `true` | Использовать быстрое определение версии, для сохранения скорости. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | Символ, используемый перед отображением версии Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | Стиль модуля. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | Стиль модуля. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Отключает модуль `git_commit`. |
|
||||
|
||||
### Переменные
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Версия пакета
|
||||
|
||||
Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ symbol = "☁️ "
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | Стиль модуля. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | Символ, используемый перед отображением версии PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | Стиль модуля. |
|
||||
| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Опции
|
||||
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Переменные
|
||||
|
||||
| Переменная | Пример | Описание |
|
||||
| ---------- | ------ | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Отражает значение параметра `symbol` |
|
||||
| style\* | | Отражает значение параметра `style` |
|
||||
|
||||
### Пример
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Параметр | По умолчанию | Описание |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | Стиль модуля. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2818,7 +2857,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. |
|
||||
| `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) |
|
||||
| `описание` | `"<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. |
|
||||
| `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. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
|
||||
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
|
||||
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | The style for the module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | Default | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | The style for the module. | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
`aws` module cho biết region và profile hiện tại của AWS. Cái này dựa trên các biến môi trường `AWS_REGION`, `AWS_DEFAULT_REGION`, và `AWS_PROFILE` với tập tin `~/.aws/config`.
|
||||
`aws` module cho biết region và profile hiện tại của AWS. Cái này dựa trên các biến môi trường `AWS_REGION`, `AWS_DEFAULT_REGION`, và `AWS_PROFILE` với tập tin `~/.aws/config`. This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
Khi sử dụng [aws-vault](https://github.com/99designs/aws-vault) profile được đọc từ biến môt trường `AWS_VAULT`.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### Các tuỳ chọn
|
||||
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ---------------- | --------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | Định dạng cho module. |
|
||||
| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. |
|
||||
| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. |
|
||||
| `style` | `"bold yellow"` | Kiểu cho module. |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Định dạng cho module. |
|
||||
| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. |
|
||||
| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. |
|
||||
| `style` | `"bold yellow"` | Kiểu cho module. |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Các biến
|
||||
|
||||
| Biến | Ví dụ | Mô tả |
|
||||
| --------- | ---------------- | -------------------------------- |
|
||||
| region | `ap-northeast-1` | Region AWS hiện tại |
|
||||
| profile | `astronauts` | Profile AWS hiện tại |
|
||||
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
|
||||
| style\* | | Giá trị ghi đè của `style` |
|
||||
| Biến | Ví dụ | Mô tả |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | Region AWS hiện tại |
|
||||
| profile | `astronauts` | Profile AWS hiện tại |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
|
||||
| style\* | | Giá trị ghi đè của `style` |
|
||||
|
||||
\*: Biến này có thể chỉ được sử dụng như một phần của style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | Kí hiệu sử dụng trước phiên bản của cmake. |
|
||||
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Tên tệp nào sẽ kích hoạt mô-đun này |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | Kiểu cho module. |
|
||||
| `detect_extensions` | `["cr"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["shard.yml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | Một chuỗi định dạng hiển thị biểu tượng của Dart |
|
||||
| `detect_extensions` | `["dart"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -793,7 +796,7 @@ Mô đun cũng sẽ hiện Target Framework Moniker (<https://docs.microsoft.com
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | Biểu tượng sử dụng để hiển thị trước phiên bản của dotnet. |
|
||||
| `heuristic` | `true` | Sử dụng phiên bản phát hiện thông minh hơn. |
|
||||
| `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. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | Định dạng cho module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | Kí hiệu sử dụng trước phiên bản hiển thị của Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["mix.exs"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | Một format string đại diện cho biểu tượng của Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | Biểu tượng sử dụng để hiển thị trước phiên bản của erlang. |
|
||||
| `style` | `"bold red"` | 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. |
|
||||
@ -1095,7 +1098,7 @@ Mô đun `git_commit` hiển thị hash commit hiện tại và tag (nếu có)
|
||||
| `style` | `"bold green"` | Kiểu cho module. |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Vô hiệu hiển thị thông tin tag trong mô đun `git_commit`. |
|
||||
| `tag_symbol` | `"🏷 "` | Biểu tượng tag trước thông tin được hiển thị |
|
||||
| `tag_symbol` | `" 🏷 "` | Biểu tượng tag trước thông tin được hiển thị |
|
||||
| `disabled` | `false` | Vô hiệu mô đun `git_commit`. |
|
||||
|
||||
### Các biến
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | Một format string đại diện cho biểu tượng của Go. |
|
||||
| `detect_extensions` | `["go"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `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. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `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. |
|
||||
| `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. |
|
||||
| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.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 nên kích hoạt các mô đun này. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | 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 nên kích hoạt các mô đun này. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `[".lua-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["nim.cfg"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `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. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### Các tuỳ chọn
|
||||
|
||||
| Tuỳ chọn | Mặc định | Mô tả | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | |
|
||||
| `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. | |
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `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
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["spago.dhall"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -2105,7 +2110,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | Kiểu cho module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | 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. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_folders` | `[".metals"]` | Những thư mục nào nên kích hoạt các mô đun này. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["Package.swift"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -2544,7 +2549,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | 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. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Tên tệp nào sẽ kích hoạt mô-đun này. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### Các tuỳ chọn
|
||||
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | -------------------------------------------- | --------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | 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` | `"blue bold"` | Kiểu cho module. |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Các biến
|
||||
|
||||
| Biến | Ví dụ | Mô tả |
|
||||
| --------- | ------ | -------------------------------- |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
|
||||
| style\* | | Giá trị ghi đè của `style` |
|
||||
|
||||
### Ví dụ
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Tuỳ chọn | Mặc định | Mô tả |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | Kiểu cho module. |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2818,7 +2857,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. |
|
||||
| `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) |
|
||||
| `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. |
|
||||
| `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. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
`aws` 组件显示当前 AWS 主机所在区域与配置信息。 各组件基于 `AWS_REGION`，`AWS_DEFAULT_REGION` 和 `AWS_PROFILE` 环境变量与 `~/.aws/config` 文件。
|
||||
`aws` 组件显示当前 AWS 主机所在区域与配置信息。 各组件基于 `AWS_REGION`，`AWS_DEFAULT_REGION` 和 `AWS_PROFILE` 环境变量与 `~/.aws/config` 文件。 This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### 配置项
|
||||
|
||||
| Option | 默认值 | 描述 |
|
||||
| ---------------- | --------------------------------------------------- | -------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | 组件格式化模板。 |
|
||||
| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 |
|
||||
| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 |
|
||||
| `style` | `"bold yellow"` | 此组件的样式。 |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | 组件格式化模板。 |
|
||||
| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 |
|
||||
| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 |
|
||||
| `style` | `"bold yellow"` | 此组件的样式。 |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| 字段 | 示例 | 描述 |
|
||||
| --------- | ---------------- | ----------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | `symbol`对应值 |
|
||||
| style\* | | `style`对应值 |
|
||||
| 字段 | 示例 | 描述 |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | `symbol`对应值 |
|
||||
| style\* | | `style`对应值 |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | 此组件的样式。 |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | 这个字段的内容会显示在当前 .NET 版本之前。 |
|
||||
| `heuristic` | `true` | 使用更快的版本探测机制以保证 starship 的运行速度。 |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | 此组件的样式。 |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | 此组件的样式。 |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | 禁用 `git_commit` 组件。 |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## Package Version
|
||||
|
||||
当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ symbol = "☁️ "
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠ 此组件显示的是源代码在当前目录中的软件包的版本，而不是包管理器的版本。
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### 配置项
|
||||
|
||||
| Option | 默认值 | 描述 | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | 此组件的样式。 | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | 此组件的样式。 |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | 这个字段的内容会显示在当前 PHP 版本之前。 |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | 默认值 | 描述 |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | 用于表示Python的格式化字符串。 |
|
||||
| `style` | `"yellow bold"` | 此组件的样式。 |
|
||||
| `pyenv_version_name` | `false` | 使用 pyenv 获取 Python 版本 |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### 配置项
|
||||
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | 此组件的样式。 |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| 字段 | 示例 | 描述 |
|
||||
| --------- | ------ | ------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | `symbol`对应值 |
|
||||
| style\* | | `style`对应值 |
|
||||
|
||||
### 示例
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | 默认值 | 描述 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | 此组件的样式。 |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2818,7 +2857,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. |
|
||||
| `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) |
|
||||
| `描述` | `"<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. |
|
||||
| `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. |
|
||||
|
||||
@ -214,6 +214,7 @@ $rust\
|
||||
$scala\
|
||||
$swift\
|
||||
$terraform\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$zig\
|
||||
$nix_shell\
|
||||
@ -238,32 +239,34 @@ $character"""
|
||||
|
||||
## AWS
|
||||
|
||||
`aws` 模組顯示現在 AWS 的區域與概況。 這是根據 `AWS_REGION`、`AWS_DEFAULT_REGION` 與 `AWS_PROFILE` 環境變數及 `~/.aws/config` 檔案。
|
||||
`aws` 模組顯示現在 AWS 的區域與概況。 這是根據 `AWS_REGION`、`AWS_DEFAULT_REGION` 與 `AWS_PROFILE` 環境變數及 `~/.aws/config` 檔案。 This module also shows an expiration timer when using temporary credentials.
|
||||
|
||||
從 `AWS_VAULT`讀取而使用 [aws-vault](https://github.com/99designs/aws-vault) 這個設定檔
|
||||
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.
|
||||
|
||||
When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.
|
||||
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var.
|
||||
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
|
||||
|
||||
### 選項
|
||||
|
||||
| Option | 預設 | 說明 |
|
||||
| ---------------- | --------------------------------------------------- | -------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 |
|
||||
| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 |
|
||||
| `style` | `"bold yellow"` | 這個模組的風格。 |
|
||||
| `disabled` | `false` | Disables the `aws` module. |
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. |
|
||||
| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 |
|
||||
| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 |
|
||||
| `style` | `"bold yellow"` | 這個模組的風格。 |
|
||||
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
|
||||
| `disabled` | `false` | Disables the `AWS` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| 變數 | 範例 | 說明 |
|
||||
| --------- | ---------------- | ------------------------------------ |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| 變數 | 範例 | 說明 |
|
||||
| --------- | ---------------- | ------------------------------------------- |
|
||||
| region | `ap-northeast-1` | The current AWS region |
|
||||
| profile | `astronauts` | The current AWS profile |
|
||||
| duration | `2h27m20s` | The temporary credentials validity duration |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
@ -447,7 +450,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"△ "` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
|
||||
@ -567,7 +570,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `"bold red"` | 這個模組的風格。 |
|
||||
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
|
||||
@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
|
||||
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
|
||||
@ -643,7 +646,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
|
||||
@ -793,7 +796,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `".NET "` | 在顯示 dotnet 版本之前用的符號。 |
|
||||
| `heuristic` | `true` | 使用更快速的版本偵測法來保持 starship 的速度。 |
|
||||
| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
|
||||
@ -835,7 +838,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
|
||||
@ -878,7 +881,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
|
||||
@ -954,7 +957,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
|
||||
| `style` | `"bold red"` | 這個模組的風格。 |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
@ -1095,7 +1098,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `style` | `"bold green"` | 這個模組的風格。 |
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@ -1258,7 +1261,7 @@ The `golang` module shows the currently installed version of [Golang](https://go
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
|
||||
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
|
||||
@ -1297,7 +1300,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1371,7 +1374,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1451,7 +1454,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1489,7 +1492,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
@ -1600,7 +1603,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
|
||||
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
|
||||
@ -1725,7 +1728,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
|
||||
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
|
||||
@ -1807,7 +1810,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `" "` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
|
||||
@ -1851,7 +1854,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
|
||||
| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. |
|
||||
| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. |
|
||||
@ -1919,10 +1922,11 @@ symbol = "☁️ "
|
||||
|
||||
## 套件版本
|
||||
|
||||
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 這個模組目前支援 `npm`、`cargo`、`poetry`、`composer`、`gradle`、`julia`、`mix`, 跟 `helm` 套件
|
||||
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
|
||||
- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
|
||||
@ -1931,6 +1935,7 @@ The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並
|
||||
- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
|
||||
- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
|
||||
- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
|
||||
- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
|
||||
|
||||
> ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的，並非從套件管理員取得。
|
||||
|
||||
@ -1975,16 +1980,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
|
||||
|
||||
### 選項
|
||||
|
||||
| Option | 預設 | 說明 | **** |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. | |
|
||||
| `style` | `"bold 149"` | 這個模組的風格。 | |
|
||||
| `disabled` | `false` | Disables the `perl` module. | |
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
|
||||
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"bold 149"` | 這個模組的風格。 |
|
||||
| `disabled` | `false` | Disables the `perl` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@ -2016,7 +2021,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
|
||||
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
|
||||
@ -2055,7 +2060,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
|
||||
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
|
||||
@ -2105,7 +2110,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | 預設 | 說明 |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
|
||||
| `style` | `"yellow bold"` | 這個模組的風格。 |
|
||||
| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 |
|
||||
@ -2171,7 +2176,7 @@ By default the `red` module shows the currently installed version of [Red](https
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
|
||||
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2211,7 +2216,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
|
||||
| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
|
||||
@ -2250,7 +2255,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
|
||||
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
|
||||
@ -2290,7 +2295,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
|
||||
@ -2497,7 +2502,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
|
||||
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
|
||||
@ -2544,7 +2549,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"💠"` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
@ -2685,7 +2690,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
|
||||
@ -2712,6 +2717,40 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
|
||||
format = "via [⍱ $version](bold white) "
|
||||
```
|
||||
|
||||
## VLang
|
||||
|
||||
The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a file with `.v` extension
|
||||
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
|
||||
|
||||
### 選項
|
||||
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `symbol` | `"V "` | A format string representing the symbol of V |
|
||||
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `"blue bold"` | 這個模組的風格。 |
|
||||
| `disabled` | `false` | Disables the `vlang` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| 變數 | 範例 | 說明 |
|
||||
| --------- | ------ | ------------------------------------ |
|
||||
| version | `v0.2` | The version of `v` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### 範例
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[v]
|
||||
format = "via [V $version](blue bold) "
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
|
||||
@ -2755,7 +2794,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
|
||||
| Option | 預設 | 說明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
|
||||
| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `"bold yellow"` | 這個模組的風格。 |
|
||||
| `disabled` | `false` | Disables the `zig` module. |
|
||||
@ -2818,7 +2857,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. |
|
||||
| `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) |
|
||||
| `說明` | `"<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. |
|
||||
| `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. |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user