Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-18 19:15:14 +00:00
Code Issues Releases Activity
f0126dc336
starship/docs/ru-RU/config/README.md
Matan Kushner 658ac246dc New translations README.md (Russian)
2023-09-17 01:29:01 +01:00

4399 lines
276 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Конфигурация
Чтобы начать конфигурацию Starship, создайте следующий файл: `~/.config/starship.toml`.
```sh
mkdir -p ~/.config && touch ~/.config/starship.toml
```
Вся конфигурация Starship выполняется в этом файле [TOML](https://github.com/toml-lang/toml):
```toml
# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'
# Inserts a blank line between shell prompts
add_newline = true
# Replace the '❯' symbol in the prompt with '➜'
[character] # The name of the module we are configuring is 'character'
success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
# Disable the package module, hiding it from the prompt completely
[package]
disabled = true
```
### Расположение конфигурационного файла
Вы можете задать расположение конфигурационного файла по умолчанию через переменную окружения `STARSHIP_CONFIG`:
```sh
export STARSHIP_CONFIG=~/example/non/default/path/starship.toml
```
Аналогично в PowerShell (Windows) следует добавить эту строку в `$PROFILE`:
```powershell
$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"
```
Или для Cmd (Windows) добавить следующую строчку в ваш файл `starship.lua`:
```lua
os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')
```
### Логгирование (Запись действий)
By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal. Это, однако, может быть изменено с помощью переменной окружения `STARSHIP_CACHE`:
```sh
export STARSHIP_CACHE=~/.starship/cache
```
Аналогично в PowerShell (Windows) следует добавить эту строку в `$PROFILE`:
```powershell
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
Или для Cmd (Windows) добавить следующую строчку в ваш файл `starship.lua`:
```lua
os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
```
### Терминология
**Модуль**: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "nodejs" отображает установленную версию Node.js, если вы находитесь в директории Node.js проекта.
**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js.
По традициям, большинство модулей имеют префикс цвета терминала по умолчанию (например, `через` в "узлах") и пустое пространство как суффикс.
### Strings
In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
| Symbol | Type | Notes |
| ------ | ------------------------- | ------------------------------------------------------ |
| `'` | literal string | less escaping |
| `"` | string | more escaping |
| `'''` | multi-line literal string | less escaping |
| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
Например:
```toml
# literal string
format = '☺\☻ '
# regular string
format = "☺\\☻ "
# escaping Starship symbols
format = '\[\$\] '
```
When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:
```toml
# with literal string
format = '''
\$'''
# with multiline basic string
format = """
\\$"""
# with basic string
format = "\n\\$"
```
In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.
```toml
format = """
line1\
line1\
line1
line2\
line2\
line2
"""
```
### Форматирование строк
Формат строк - это формат, с которым модуль печатает все переменные. Большинство модулей имеют запись `формата`, который настраивает формат отображения модуля. Вы можете использовать тексты, переменные и группы текста в строке формата.
#### Переменная
Переменная содержит символ `$`, за которым следует имя переменной. The name of a variable can only contain letters, numbers and `_`.
Например:
- `'$version'` is a format string with a variable named `version`.
- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.
- `'$git_branch $git_commit'` has the two variables separated with a space.
#### Группа текста
Текстовая группа состоит из двух различных частей.
Первая часть, которая заключена в `[]`, это [формат строки](#format-strings). Вы можете добавлять в него тексты, переменные, или даже вложенные текстовые группы.
Во второй части, которая заключена в `()`, это строка стиля [](#style-strings). This can be used to style the first part.
Например:
- `'[on](red bold)'` will print a string `on` with bold text colored red.
- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.
#### Строки стиля
В Starship, большинство модулей позволяют настроить стили отображения. Это делается записью (обычно называется `style`), которая представляет собой строку, определяющую конфигурацию. Ниже приведены несколько примеров стилей строк, а также, их действия. Подробнее о полном синтаксисе можно прочитать в [расширенном разделе конфигурации](/advanced-config/).
- `'fg:green bg:blue'` sets green text on a blue background
- `'bg:blue fg:bright-green'` sets bright green text on a blue background
- `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
- `'underline bg:#bf5700'` sets underlined text on a burnt orange background
- `'bold italic fg:purple'` sets bold italic purple text
- `''` explicitly disables all styling
Обратите внимание на то, что, вид стиля зависит от вашего эмулятора терминала. Например, некоторые эмуляторы терминала будут использовать яркие цвета вместо жирного текста, и некоторые цветовые темы используют одинаковые значение для обычных и ярких цветов. Также, чтобы получить курсивный текст, ваш терминал должен поддерживать курсив.
#### Строки условного формата
Строка условного формата, завернутая в `(` и `)` не будет отображаться, если все переменные внутри являются пустыми.
Например:
- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.
- When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`.
### Negative matching
Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched.
Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.
To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:
```toml
detect_extensions = ['ts', '!video.ts', '!audio.ts']
```
## Командная строка
Ниже находится список опций, применяющихся для всей командной строки.
### Опции
| Параметр | По умолчанию | Описание |
| ----------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [ссылка](#default-prompt-format) | Настройка форматирования оболочки. |
| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Тайм-аут запуска сканирования файлов (в миллисекундах). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
### Пример
```toml
# ~/.config/starship.toml
# Use custom format
format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) '''
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
# Disable the blank line at the start of the prompt
add_newline = false
# Set 'foo' as custom color palette
palette = 'foo'
# Define custom colors
[palettes.foo]
# Overwrite existing color
blue = '21'
# Define new color
mustard = '#af8700'
```
### Формат оболочки по умолчанию
Формат по умолчанию `format` используется для определения формата подсказки (prompt), если `format` пустой или отсутствует. Значение по умолчанию:
```toml
format = '$all'
# Which is equivalent to
format = """
$username\
$hostname\
$localip\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$fossil_branch\
$fossil_metrics\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$pijul_channel\
$docker_context\
$package\
$c\
$cmake\
$cobol\
$daml\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$fennel\
$golang\
$guix_shell\
$haskell\
$haxe\
$helm\
$java\
$julia\
$kotlin\
$gradle\
$lua\
$nim\
$nodejs\
$ocaml\
$opa\
$perl\
$php\
$pulumi\
$purescript\
$python\
$raku\
$rlang\
$red\
$ruby\
$rust\
$scala\
$solidity\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$buf\
$nix_shell\
$conda\
$meson\
$spack\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$os\
$container\
$shell\
$character"""
```
If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg.
```toml
# Move the directory to the second line
format = '$all$directory$character'
```
## AWS
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.
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 and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.
When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Формат модуля. |
| `symbol` | `'☁️ '` | Символ перед отображением текущего профиля AWS. |
| `region_aliases` | `{}` | Таблица региона псевдонимов, отображаемая вместе с именем AWS. |
| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Отключение модуля `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------------- | ------------------------------------------- |
| регион | `ap-northeast-1` | Текущий регион AWS |
| профиль | `astronauts` | Текущий профиль AWS |
| duration | `2h27m20s` | The temporary credentials validity duration |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Примеры
#### Отобразить все
```toml
# ~/.config/starship.toml
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
#### Отобразить регион
```toml
# ~/.config/starship.toml
[aws]
format = 'on [$symbol$region]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'
```
#### Отобразить профиль
```toml
# ~/.config/starship.toml
[aws]
format = 'on [$symbol$profile]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
### Опции
| Переменная | По умолчанию | Описание |
| ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |
| `symbol` | `'󰠅 '` | The symbol used in the format. |
| `style` | `'blue bold'` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |
### Примеры
#### Display Subscription Name
```toml
# ~/.config/starship.toml
[azure]
disabled = false
format = 'on [$symbol($subscription)]($style) '
symbol = '󰠅 '
style = 'blue bold'
```
#### Display Username
```toml
# ~/.config/starship.toml
[azure]
disabled = false
format = "on [$symbol($username)]($style) "
symbol = "󰠅 "
style = "blue bold"
```
#### Display Subscription Name Alias
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
## Батарея
Модуль `battery` показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%.
### Опции
| Параметр | По умолчанию | Описание |
| -------------------- | --------------------------------- | ------------------------------------------------------- |
| `full_symbol` | `'󰁹 '` | Символ, отображаемый при полной батарее. |
| `charging_symbol` | `'󰂄 '` | Символ, показываемый при зарядке аккумулятора. |
| `discharging_symbol` | `'󰂃 '` | Символ, показываемый при разрядке аккумулятора. |
| `unknown_symbol` | `'󰁽 '` | Символ, отображаемый при неизвестном состоянии батареи. |
| `empty_symbol` | `'󰂎 '` | Символ, отображаемый при пустом состоянии батареи. |
| `format` | `'[$symbol$percentage]($style) '` | Формат модуля. |
| `display` | [ссылка](#battery-display) | Порог отображения и стиль для модуля. |
| `disabled` | `false` | Отключает модуль `battery`. |
### Пример
```toml
# ~/.config/starship.toml
[battery]
full_symbol = '🔋 '
charging_symbol = '⚡️ '
discharging_symbol = '💀 '
```
### Отображение батареи
The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). Если `display` не предоставлено. Значение по умолчанию:
```toml
[[battery.display]]
threshold = 10
style = 'bold red'
```
The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.
#### Опции
Опция `display` представляет собой массив следующей таблицы.
| Параметр | По умолчанию | Описание |
| -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | Верхняя граница опции отображения. |
| `style` | `'red bold'` | Используемый стиль, если используется опция отображения. |
| `charging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
#### Пример
```toml
[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
style = 'bold red'
[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = 'bold yellow'
discharging_symbol = '💦'
# when capacity is over 30%, the battery indicator will not be displayed
```
## Buf
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if all of the following conditions are met:
- The [`buf`](https://github.com/bufbuild/buf) CLI is installed.
- The current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |
| `version_format` | `'v${raw}'` | The version format. |
| `symbol` | `'🐃 '` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `elixir`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| `version` | `v1.0.0` | The version of `buf` |
| `symbol` | | Отражает значение параметра `symbol` |
| `style`* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[buf]
symbol = '🦬 '
```
## Bun
The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `bun.lockb`
- Текущий каталог содержит файл `bunfig.toml`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold red'` | Стиль модуля. |
| `disabled` | `false` | Disables the `bun` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v0.1.4` | The version of `bun` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[bun]
format = 'via [🍔 $version](bold green) '
```
## C
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'C '` | The symbol used before displaying the compiler details |
| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | How to detect what the compiler is |
| `style` | `'bold 149'` | Стиль модуля. |
| `disabled` | `false` | Disables the `c` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| name | clang | The name of the compiler |
| version | 13.0.0 | The version of the compiler |
| symbol | | Отражает значение параметра `symbol` |
| style | | Отражает значение параметра `style` |
NB that `version` is not in the default format.
### Commands
The `commands` option accepts a list of commands to determine the compiler version and name.
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
### Пример
```toml
# ~/.config/starship.toml
[c]
format = 'via [$name $version]($style)'
```
## Символ
Модуль `character` показывает символ (обычно, стрелка) рядом с вводимым текстом в терминале.
Символ показывает, была ли последняя команда успешной или нет. It can do this in two ways:
- changing color (`red`/`green`)
- changing shape (`❯`/`✖`)
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
::: warning
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
:::
### Опции
| Параметр | По умолчанию | Описание |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'$symbol '` | The format string used before the text input. |
| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Отключает модуль `character`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | -------------------------------------------------------------------------------------------------------- |
| symbol | | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. |
### Примеры
#### With custom error shape
```toml
# ~/.config/starship.toml
[character]
success_symbol = '[➜](bold green) '
error_symbol = '[✗](bold red) '
```
#### Without custom error shape
```toml
# ~/.config/starship.toml
[character]
success_symbol = '[➜](bold green) '
error_symbol = '[➜](bold red) '
```
#### With custom vim shape
```toml
# ~/.config/starship.toml
[character]
vimcmd_symbol = '[V](bold green) '
```
## CMake
The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'△ '` | The symbol used before the version of cmake. |
| `detect_extensions` | `[]` | Which extensions should trigger this module |
| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `cmake` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| version | `v3.17.3` | The version of cmake |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
## COBOL / GNUCOBOL
The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:
- The current directory contains any files ending in `.cob` or `.COB`
- The current directory contains any files ending in `.cbl` or `.CBL`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold blue'` | Стиль модуля. |
| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `cobol` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------- | ------------------------------------ |
| version | `v3.1.2.0` | The version of `cobol` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
## Длительность команды
Модуль `cmd_duration` показывает время исполнения последней команды. Модуль будет показан только, если команда заняла более двух секунд, или если задан параметр `min_time`.
::: warning Не подключайте ловушку DEBUG к Bash
Если вы испоьзуете Starship в `bash`, не подключайте ловушку `DEBUG` после запуска `eval $(starship init $0)`, иначе этот модуль сломается.
:::
Пользователи Bash, которым нужна функциональность, подобная preexec, могут использовать [фреймворк bash_preexec от rcaloras](https://github.com/rcaloras/bash-preexec). Просто определите массивы `preexec_functions` и `precmd_functions` перед запуском `eval $(starship init $0)`, а затем продолжайте нормально.
### Опции
| Параметр | По умолчанию | Описание |
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Кратчайшая продолжительность для показа времени (в миллисекундах). |
| `show_milliseconds` | `false` | Показывать миллисекунды в дополнение к секундам в продолжительности. |
| `format` | `'took [$duration]($style) '` | Формат модуля. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `cmd_duration`. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
| `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | --------------------------------------- |
| duration | `16m40s` | The time it took to execute the command |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
format = 'underwent [$duration](bold yellow)'
```
## Конда
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
::: tip
Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `truncation_length` | `1` | Количество каталогов, в которых путь к окружению должен быть усечен, если окружение было создано через `conda create -p [path]`. `0` означает без усечения. Также смотрите модуль [`directory`](#directory). |
| `symbol` | `'🅒 '` | Символ перед названием окружения. |
| `style` | `'bold green'` | Стиль модуля. |
| `format` | `'via [$symbol$environment]($style) '` | Формат модуля. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Отключает модуль `conda`. |
### Переменные
| Переменная | Пример | Описание |
| ----------- | ------------ | ------------------------------------ |
| environment | `astronauts` | The current conda environment |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[conda]
format = '[$symbol$environment](dimmed green) '
```
## Container
The `container` module displays a symbol and container name, if inside a container.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | ---------------------------------- | ----------------------------------------- |
| `symbol` | `'⬢'` | The symbol shown, when inside a container |
| `style` | `'bold red dimmed'` | Стиль модуля. |
| `format` | `'[$symbol \[$name\]]($style) '` | Формат модуля. |
| `disabled` | `false` | Disables the `container` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------------- | ------------------------------------ |
| name | `fedora-toolbox:35` | The name of the container |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[container]
format = '[$symbol \[$name\]]($style) '
```
## Crystal
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `shard.yml`
- Текущий каталог содержит файл `.cr`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `symbol` | `'🔮 '` | Символ, используемый перед отображением версии crystal. |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold red'` | Стиль модуля. |
| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |
| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Отключает модуль `crystal`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| version | `v0.32.1` | The version of `crystal` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[crystal]
format = 'via [✨ $version](bold blue) '
```
## Daml
The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `daml.yaml`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'Λ '` | A format string representing the symbol of Daml |
| `style` | `'bold cyan'` | Стиль модуля. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[daml]
format = 'via [D $version](bold bright-green) '
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |
| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |
| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `dart` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v2.8.4` | The version of `dart` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[dart]
format = 'via [🔰 $version](bold red) '
```
## Deno
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'green bold'` | Стиль модуля. |
| `disabled` | `false` | Disables the `deno` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v1.8.3` | The version of `deno` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
### Пример
```toml
# ~/.config/starship.toml
[deno]
format = 'via [🦕 $version](green bold) '
```
## Каталог
Модуль `directory` показывает путь к вашей текущей директории, усеченной до трех родительских папок. Ваш каталог также будет отсечен до корня git репозитория, в котором вы находитесь.
When using the `fish_style_pwd_dir_length` option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
Например, возьмем `~/Dev/Nix/nixpkgs/pkgs` где `nixpkgs` является корневым репозиторием, и в опции установлено `1`. Вы увидите `~/D/N/nixpkgs/pkgs`, а до этого было бы `nixpkgs/pkgs`.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `3` | Количество родительских папок, к которым должен быть усечен текущий каталог. |
| `truncate_to_repo` | `true` | Следует или нет обрезать до корня репозитория git, в котором вы находитесь. |
| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | Формат модуля. |
| `style` | `'bold cyan'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `directory`. |
| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |
| `read_only_style` | `'red'` | The style for the read only symbol. |
| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…/' |
| `before_repo_root_style` | | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |
| `repo_root_style` | | The style for the root of the git repo. The default value is equivalent to `style`. |
| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |
| `home_symbol` | `'~'` | The symbol indicating home directory. |
| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
<details>
<summary>Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога.</summary>
| Advanced Option | По умолчанию | Описание |
| --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | Количество символов, используемых при использовании логики создания пути из fish. |
| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
```toml
[directory.substitutions]
'/Volumes/network/path' = '/net'
'src/com/long/java/path' = 'mypath'
```
`fish_style_pwd_dir_length` взаимодействует со стандартными параметрами усечения, которые могут сначала показаться странными: если он не равен нулю, элементы пути, который обычно усекается, вместо этого отображаются с указанным количеством символов. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
</details>
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------------------- | ----------------------------------- |
| path | `'D:/Projects'` | The current directory path |
| style\* | `'black bold dimmed'` | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
<details>
<summary>The git repos have additional variables.</summary>
Let us consider the path `/path/to/home/git_repo/src/lib`
| Переменная | Пример | Описание |
| ------------------ | --------------------- | --------------------------------------- |
| before_root_path | `'/path/to/home/'` | The path before git root directory path |
| repo_root | `'git_repo'` | The git root directory name |
| path | `'/src/lib'` | The remaining path |
| style | `'black bold dimmed'` | Отражает значение параметра `style` |
| repo_root_style | `'underline white'` | Style for git root directory name |
</details>
### Пример
```toml
# ~/.config/starship.toml
[directory]
truncation_length = 8
truncation_symbol = '…/'
```
## Контекст Docker
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use).
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `'via [$symbol$context]($style) '` | Формат модуля. |
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
| `only_with_files` | `true` | Only show when there's a match |
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `'blue bold'` | Стиль модуля. |
| `disabled` | `false` | Disables the `docker_context` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------------- | ------------------------------------ |
| context | `test_context` | The current docker context |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[docker_context]
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. Если SDK был закреплен в текущей директории, будет показана закрепленная версия. В противном случае модуль отображает последнюю установленную версию SDK.
By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
- `global.json`
- `project.json`
- `Directory.Build.props`
- `Directory.Build.targets`
- `Packages.props`
- `*.csproj`
- `*.fsproj`
- `*.xproj`
You'll also need the .NET Core SDK installed in order to use it correctly.
Внутренне этот модуль использует свой собственный механизм определения версий. Обычно он в два раза быстрее, чем `dotnet --version`, но он может показывать неправильную версию, если ваш .NET проект имеет необычный формат каталога. Если точность важнее, чем скорость, вы можете отключить механизм опцией `heuristic = false` в настройках модуля.
The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(🎯 $tfm )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'.NET '` | Символ перед отображением текущей версии dotnet. |
| `heuristic` | `true` | Использовать быстрое определение версии, для сохранения скорости. |
| `detect_extensions` | `['csproj', 'fsproj', 'xproj']` | Which extensions should trigger this module. |
| `detect_files` | `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `dotnet`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------------- | ------------------------------------------------------------------ |
| version | `v3.1.201` | The version of `dotnet` sdk |
| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[dotnet]
symbol = '🥅 '
style = 'green'
heuristic = false
```
## Elixir
The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `mix.exs`.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💧 '` | Символ, используемый перед отображением версии Elixir/Erlang. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['mix.exs']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `'bold purple'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `elixir`. |
### Переменные
| Переменная | Пример | Описание |
| ----------- | ------- | ------------------------------------ |
| version | `v1.10` | The version of `elixir` |
| otp_version | | The otp version of `elixir` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[elixir]
symbol = '🔮 '
```
## Elm
The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `elm.json`
- Текущий каталог содержит файл `elm-package.json`
- Текущий каталог содержит файл `.elm-version`
- Текущий каталог содержит папку `elm-stuff`
- The current directory contains `*.elm` files
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🌳 '` | A format string representing the symbol of Elm. |
| `detect_extensions` | `['elm']` | Which extensions should trigger this module. |
| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['elm-stuff']` | Which folders should trigger this modules. |
| `style` | `'cyan bold'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `elm`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| version | `v0.19.1` | The version of `elm` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[elm]
format = 'via [ $version](cyan bold) '
```
## Переменная Окружения
The `env_var` module displays the current value of a selected environment variables. Модуль будет показан только в том случае, если любое из следующих условий соблюдено:
- Опция `variable` соответствует существующей переменной среды
- Опция `variable` не определена, но определена опция `default`
::: tip
The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined.
:::
::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable
```toml
# ~/.config/starship.toml
[env_var.USER]
default = 'unknown user'
```
:::
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | `""` | Символ, используемый перед отображением значения переменной. |
| `variable` | | Отображаемая переменная окружения. |
| `default` | | Значение отображаемое, когда выбранная переменная не определена. |
| `format` | `"with [$env_value]($style) "` | Формат модуля. |
| `описание` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
| `disabled` | `false` | Отключает модуль `env_var`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------------------------------------- | ------------------------------------------ |
| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | `black bold dimmed` | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[env_var]
variable = 'SHELL'
default = 'unknown shell'
```
Displaying multiple environmental variables:
```toml
# ~/.config/starship.toml
[env_var.SHELL]
variable = 'SHELL'
default = 'unknown shell'
[env_var.USER]
default = 'unknown user'
```
## Erlang
The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `rebar.config`.
- Текущий каталог содержит файл `erlang.mk`.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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. |
| `detect_files` | `['rebar.config', 'elang.mk']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `erlang` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| version | `v22.1.3` | The version of `erlang` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[erlang]
format = 'via [e $version](bold red) '
```
## Fennel
The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.fnl` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |
| `style` | `'bold green'` | Стиль модуля. |
| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `disabled` | `false` | Disables the `fennel` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v1.2.1` | The version of `fennel` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
## Fill
The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | -------------- | --------------------------------- |
| `symbol` | `'.'` | The symbol used to fill the line. |
| `style` | `'bold black'` | Стиль модуля. |
| `disabled` | `false` | Disables the `fill` module |
### Пример
```toml
# ~/.config/starship.toml
format = 'AA $fill BB $fill CC'
[fill]
symbol = '-'
style = 'bold green'
```
Produces a prompt that looks like:
```
AA -------------------------------------------- BB -------------------------------------------- CC
```
## Fossil Branch
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------- | --------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol$branch]($style) '` | Формат модуля. Use `'$branch'` to refer to the current branch name. |
| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. |
| `style` | `'bold purple'` | Стиль модуля. |
| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes |
| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. You can use `''` for no symbol. |
| `disabled` | `true` | Disables the `fossil_branch` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------- | ------------------------------------ |
| branch | `trunk` | The active Fossil branch |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
## Fossil Metrics
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
### Опции
| Параметр | По умолчанию | Описание |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. |
| `added_style` | `'bold green'` | The style for the added count. |
| `deleted_style` | `'bold red'` | The style for the deleted count. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `disabled` | `true` | Disables the `fossil_metrics` module. |
### Переменные
| Переменная | Пример | Описание |
| ----------------- | ------ | ------------------------------------------- |
| added | `1` | The current number of added lines |
| deleted | `2` | The current number of deleted lines |
| added_style\* | | Mirrors the value of option `added_style` |
| deleted_style\* | | Mirrors the value of option `deleted_style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## 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.
When the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active be active when one of the environment variables has been set.
### Опции
| Параметр | По умолчанию | Описание |
| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Формат модуля. |
| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `gcloud` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------- | ------------------------------------------------------------------ |
| регион | `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 | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Примеры
#### Display account and project
```toml
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
```
#### Display active config name only
```toml
# ~/.config/starship.toml
[gcloud]
format = '[$symbol$active]($style) '
style = 'bold yellow'
```
#### Display account and aliased region
```toml
# ~/.config/starship.toml
[gcloud]
symbol = '️🇬️ '
[gcloud.region_aliases]
us-central1 = 'uc1'
asia-northeast1 = 'an1'
```
#### Display account and aliased project
```toml
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
[gcloud.project_aliases]
very-long-project-name = 'vlpn'
```
## Ветвь Git
Модуль `git_branch` показывает активную ветку репозитория в вашем текущей директории.
### Опции
| Параметр | По умолчанию | Описание |
| -------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Формат модуля. Use `'$branch'` to refer to the current branch name. |
| `symbol` | `' '` | A format string representing the symbol of git branch. |
| `style` | `'bold purple'` | Стиль модуля. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. You can use `''` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
| `disabled` | `false` | Отключает модуль `git_branch`. |
### Переменные
| Переменная | Пример | Описание |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |
| remote_name | `origin` | The remote name. |
| remote_branch | `master` | The name of the branch tracked on `remote_name`. |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[git_branch]
symbol = '🌱 '
truncation_length = 4
truncation_symbol = ''
ignore_branches = ['master', 'main']
```
## Коммит Git
The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
### Опции
| Параметр | По умолчанию | Описание |
| -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ |
| `commit_hash_length` | `7` | Длина отображаемого хэша коммита git. |
| `format` | `'[\($hash$tag\)]($style) '` | Формат модуля. |
| `style` | `'bold green'` | Стиль модуля. |
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |
| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |
| `disabled` | `false` | Отключает модуль `git_commit`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash |
| tag | `v1.0.0` | The tag name if showing tag info is enabled. |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
tag_symbol = '🔖 '
```
## Состояние Git
Модуль `git_state` будет отображаться в директориях, являющимися частью репозитория git, и там, где выполняется операция, такие как: _REBASING_, _BISECTING_, и т. д. Если есть информация о прогрессе (например, REBASING 3/10), эта информация также будет показана.
### Опции
| Параметр | По умолчанию | Описание |
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `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'` | Стиль модуля. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Формат модуля. |
| `disabled` | `false` | Отключает модуль `git_state`. |
### Переменные
| Переменная | Пример | Описание |
| ---------------- | ---------- | ----------------------------------- |
| state | `REBASING` | The current state of the repo |
| progress_current | `1` | The current operation progress |
| progress_total | `2` | The total operation progress |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = '[🍒 PICKING](bold red)'
```
## Git Metrics
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `added_style` | `'bold green'` | The style for the added count. |
| `deleted_style` | `'bold red'` | The style for the deleted count. |
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. |
| `disabled` | `true` | Disables the `git_metrics` module. |
| `ignore_submodules` | `false` | Ignore changes to submodules |
### Переменные
| Переменная | Пример | Описание |
| ----------------- | ------ | ------------------------------------------- |
| added | `1` | The current number of added lines |
| deleted | `2` | The current number of deleted lines |
| added_style\* | | Mirrors the value of option `added_style` |
| deleted_style\* | | Mirrors the value of option `deleted_style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[git_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
## Статус Git
Модуль `git_status` отображает символы, представляющие состояние репозитория в вашей текущей директории.
::: tip
The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `'='` | Эта ветка имеет конфликты слияния. |
| `ahead` | `'⇡'` | The format of `ahead` |
| `behind` | `'⇣'` | The format of `behind` |
| `diverged` | `'⇕'` | The format of `diverged` |
| `up_to_date` | `''` | The format of `up_to_date` |
| `untracked` | `'?'` | The format of `untracked` |
| `stashed` | `'$'` | The format of `stashed` |
| `modified` | `'!'` | The format of `modified` |
| `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechange` |
| `style` | `'bold red'` | Стиль модуля. |
| `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Отключает модуль `git_status`. |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
### Переменные
The following variables can be used in `format`:
| Переменная | Описание |
| -------------- | ------------------------------------------------------------------------------------------------------------- |
| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
| `stashed` | Displays `stashed` when a stash exists for the local repository. |
| `modified` | Displays `modified` when there are file modifications in the working directory. |
| `staged` | Displays `staged` when a new file has been added to the staging area. |
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
| style\* | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
The following variables can be used in `diverged`:
| Переменная | Описание |
| -------------- | ---------------------------------------------- |
| `ahead_count` | Number of commits ahead of the tracking branch |
| `behind_count` | Number of commits behind the tracking branch |
The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:
| Переменная | Описание |
| ---------- | -------------------------- |
| `count` | Показать количество файлов |
### Пример
```toml
# ~/.config/starship.toml
[git_status]
conflicted = '🏳'
ahead = '🏎💨'
behind = '😰'
diverged = '😵'
up_to_date = '✓'
untracked = '🤷'
stashed = '📦'
modified = '📝'
staged = '[++\($count\)](green)'
renamed = '👅'
deleted = '🗑'
```
Показывать счетчик впереди/позади для отслеживаемой ветки
```toml
# ~/.config/starship.toml
[git_status]
ahead = '⇡${count}'
diverged = '⇕⇡${ahead_count}⇣${behind_count}'
behind = '⇣${count}'
```
Use Windows Starship executable on Windows paths in WSL
```toml
# ~/.config/starship.toml
[git_status]
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'
```
## Go
The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `go.mod`
- Текущий каталог содержит файл `go.sum`
- Текущий каталог содержит файл `go.work`
- Текущий каталог содержит файл `glide.yaml`
- Текущий каталог содержит файл `Gopkg.yml`
- Текущий каталог содержит файл `Gopkg.lock`
- The current directory contains a `.go-version` file
- Текущий каталог содержит папку `Godeps`
- Текущий каталог содержит файл с расширением `.go`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐹 '` | A format string representing the symbol of Go. |
| `detect_extensions` | `['go']` | Which extensions should trigger this module. |
| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['Godeps']` | Which folders should trigger this module. |
| `style` | `'bold cyan'` | Стиль модуля. |
| `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |
| `disabled` | `false` | Отключает модуль `golang`. |
### Переменные
| Переменная | Пример | Описание |
| ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | The version of `go` |
| mod_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[golang]
format = 'via [🏎💨 $version](bold cyan) '
```
### Using `mod_version`
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version )]($style)'
```
## Guix-shell
The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol]($style) '` | Формат модуля. |
| `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. |
| `style` | `"yellow bold"` | Стиль модуля. |
| `disabled` | `false` | Disables the `guix_shell` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[guix_shell]
disabled = true
format = 'via [🐂](yellow bold) '
```
## Gradle
The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory.
By default the module will be shown if any of the following conditions are met:
- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory.
- The current directory contains a file ending with `.gradle` or `.gradle.kts`.
The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. |
| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `["gradle"]` | Which folders should trigger this module. |
| `style` | `"bold bright-cyan"` | Стиль модуля. |
| `disabled` | `false` | Disables the `gradle` module. |
| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v7.5.1` | The version of `gradle` |
| symbol | | Отражает значение параметра `symbol` |
| style* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot.
By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `stack.yaml`
- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | -------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `symbol` | `'λ '` | A format string representing the symbol of Haskell |
| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Which extensions should trigger this module. |
| `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold purple'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `haskell`. |
### Переменные
| Переменная | Пример | Описание |
| -------------- | ----------- | --------------------------------------------------------------------------------------- |
| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project |
| snapshot | `lts-18.12` | Currently selected Stack snapshot |
| ghc\_version | `9.2.1` | Currently installed GHC version |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
## Haxe
The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file
- The current directory contains a `.haxelib` or a `haxe_libraries` directory
- The current directory contains a file with the `.hx` or `.hxml` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["hx", "hxml"]` | Which extensions should trigger this module. |
| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Which folders should trigger this modules. |
| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. |
| `style` | `"bold fg:202"` | Стиль модуля. |
| `disabled` | `false` | Disables the `haxe` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v4.2.5` | The version of `haxe` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[haxe]
format = "via [⌘ $version](bold fg:202) "
```
## Helm
The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `helmfile.yaml`
- The current directory contains a `Chart.yaml` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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. |
| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. |
| `style` | `'bold white'` | Стиль модуля. |
| `disabled` | `false` | Disables the `helm` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v3.1.1` | The version of `helm` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[helm]
format = 'via [⎈ $version](bold white) '
```
## Имя хоста
Модуль `hostname` отображает имя системы (хоста).
### Опции
| Параметр | По умолчанию | Описание |
| ----------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Показывать имя хоста только при подключении через SSH. |
| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |
| `trim_at` | `'.'` | Символы, по которую имя хоста будет сокращено после первого совпадения. `'.'` will stop after the first dot. `''` will disable any truncation. |
| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | Формат модуля. |
| `style` | `'bold dimmed green'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `hostname`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------- | ----------------------------------------------------- |
| имя хоста | `computer` | The hostname of the computer |
| style\* | | Отражает значение параметра `style` |
| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |
*: Эта переменная может использоваться только в качестве части строки style
### Примеры
#### Always show the hostname
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
format = '[$ssh_symbol](bold blue) on [$hostname](bold red) '
trim_at = '.companyname.com'
disabled = false
```
#### Hide the hostname in remote tmux sessions
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
disabled = false
```
## Java
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Which extensions should trigger this module. |
| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `'☕ '` | A format string representing the symbol of Java |
| `style` | `'red dimmed'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `java`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| version | `v14` | The version of `java` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[java]
symbol = '🌟 '
```
## Работы
Модуль `jobs` отображает текущее количество запущенных работ. Модуль будет показан только если работы выполняются в фоне. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running.
The default functionality is:
- 0 jobs -> Nothing is shown.
- 1 job -> `symbol` is shown.
- 2 jobs or more -> `symbol` + `number` are shown.
::: warning
This module is not supported on tcsh and nu.
:::
::: warning
The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------ |
| `threshold`* | `1` | Показывать количество работ, если превышено. |
| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |
| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |
| `format` | `'[$symbol$number]($style) '` | Формат модуля. |
| `symbol` | `'✦'` | The string used to represent the `symbol` variable. |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `jobs`. |
*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| number | `1` | The number of jobs |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[jobs]
symbol = '+ '
number_threshold = 4
symbol_threshold = 0
```
## Julia
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file
- The current directory contains a file with the `.jl` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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. |
| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. |
| `style` | `'bold purple'` | Стиль модуля. |
| `disabled` | `false` | Disables the `julia` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v1.4.0` | The version of `julia` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[julia]
symbol = '∴ '
```
## Kotlin
The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.kt` or a `.kts` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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. |
| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. |
| `style` | `'bold blue'` | Стиль модуля. |
| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| version | `v1.4.21` | The version of `kotlin` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[kotlin]
symbol = '🅺 '
```
```toml
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = 'kotlinc'
```
## Kubernetes
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions.
:::
### Опции
::: warning
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
:::
| Параметр | По умолчанию | Описание |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Формат модуля. |
| `style` | `'cyan bold'` | Стиль модуля. |
| `context_aliases`* | `{}` | Table of context aliases to display. |
| `user_aliases`* | `{}` | Table of user aliases to display. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
| `disabled` | `true` | Отключает модуль `kubernetes`. |
*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead.
To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list:
| Переменная | Описание |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. |
| `user_pattern` | Regular expression to match current Kubernetes user name. |
| `context_alias` | Context alias to display instead of the full context name. |
| `user_alias` | User alias to display instead of the full user name. |
| `style` | The style for the module when using this context. If not set, will use module's style. |
| `symbol` | The symbol for the module when using this context. If not set, will use module's symbol. |
Note that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)).
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------------------- | ---------------------------------------- |
| context | `starship-context` | The current kubernetes context name |
| namespace | `starship-namespace` | If set, the current kubernetes namespace |
| user | `starship-user` | If set, the current kubernetes user |
| cluster | `starship-cluster` | If set, the current kubernetes cluster |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false
contexts = [
{ context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
]
```
Only show the module in directories that contain a `k8s` file.
```toml
# ~/.config/starship.toml
[kubernetes]
disabled = false
detect_files = ['k8s']
```
#### Kubernetes Context specific config
The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.
```toml
# ~/.config/starship.toml
[[kubernetes.contexts]]
# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
# equals "admin_user"
context_pattern = "production"
user_pattern = "admin_user"
style = "bold red"
context_alias = "prod"
user_alias = "admin"
[[kubernetes.contexts]]
# "green" style + a different symbol when Kubernetes current context name contains openshift
context_pattern = ".*openshift.*"
style = "green"
symbol = "💔 "
context_alias = "openshift"
[[kubernetes.contexts]]
# Using capture groups
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
context_alias = "gke-$cluster"
```
## Разрыв Строки
Модуль `line_break` разделяет командную строку на две строки.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | ------------ | ------------------------------------------------------------------------ |
| `disabled` | `false` | Отключает модуль `line_break`, отображая командную строку в одну строку. |
### Пример
```toml
# ~/.config/starship.toml
[line_break]
disabled = true
```
## Local IP
The `localip` module shows the IPv4 address of the primary network interface.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | ------------------------- | ------------------------------------------------------ |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
| `format` | `'[$localipv4]($style) '` | Формат модуля. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `true` | Disables the `localip` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------ | ----------------------------------- |
| localipv4 | 192.168.1.13 | Contains the primary IPv4 address |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[localip]
ssh_only = false
format = '@[$localipv4](bold red) '
disabled = false
```
## Lua
The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory
- The current directory contains a file with the `.lua` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. |
| `detect_extensions` | `['lua']` | Which extensions should trigger this module. |
| `detect_files` | `['.lua-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['lua']` | Which folders should trigger this module. |
| `style` | `'bold blue'` | Стиль модуля. |
| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[lua]
format = 'via [🌕 $version](bold blue) '
```
## Использование памяти
Модуль `memory_usage` отображает текущую системную память и использование подкачки.
По умолчанию использование подкачки отображается, если общая сумма подкачки системы не равна нулю.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ----------- | ----------------------------------------------- | ------------------------------------------------------------------ |
| `threshold` | `75` | Скрывать использование памяти, если она не превышает этот процент. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Формат модуля. |
| `symbol` | `'🐏'` | Символ, используемый перед отображением использования памяти. |
| `style` | `'bold dimmed white'` | Стиль модуля. |
| `disabled` | `true` | Отключает модуль `memory_usage`. |
### Переменные
| Переменная | Пример | Описание |
| ---------------- | ------------- | ------------------------------------------------------------------ |
| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. |
| ram_pct | `48%` | The percentage of the current system memory. |
| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. |
| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. |
| symbol | `🐏` | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system
### Пример
```toml
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
symbol = ' '
style = 'bold dimmed green'
```
## Meson
The `meson` module shows the current Meson developer environment status.
By default the Meson project name is displayed, if `$MESON_DEVENV` is set.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- |
| `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. |
| `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. |
| `format` | `'via [$symbol$project]($style) '` | Формат модуля. |
| `symbol` | `'⬢ '` | The symbol used before displaying the project name. |
| `style` | `'blue bold'` | Стиль модуля. |
| `disabled` | `false` | Disables the `meson` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------- | ------------------------------------ |
| project | `starship` | The current Meson project name |
| symbol | `🐏` | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[meson]
disabled = false
truncation_symbol = '--'
symbol = ' '
style = 'bold dimmed green'
```
## Ветвь Mercurial
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------- |
| `symbol` | `' '` | Символ, используемый перед закладкой hg или именем ветви репозитория в текущем каталоге. |
| `style` | `'bold purple'` | Стиль модуля. |
| `format` | `'on [$symbol$branch(:$topic)]($style) '` | Формат модуля. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes |
| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. |
| `disabled` | `true` | Отключает модуль `hg_branch`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| branch | `master` | The active mercurial branch |
| topic | `feature` | The active mercurial topic |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[hg_branch]
format = 'on [🌱 $branch](bold purple)'
truncation_length = 4
truncation_symbol = ''
```
## Nim
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `nim.cfg`
- The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля |
| `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. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `false` | Disables the `nim` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v1.2.0` | The version of `nimc` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[nim]
style = 'yellow'
symbol = '🎣 '
```
## Nix-shell
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. Модуль будет показываться внутри среды nix-shell.
### Опции
| Параметр | По умолчанию | Описание |
| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | Формат модуля. |
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
| `style` | `'bold blue'` | Стиль модуля. |
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. |
| `disabled` | `false` | Отключает модуль `nix_shell`. |
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------- | ------------------------------------ |
| state | `pure` | The state of the nix-shell |
| name | `lorri` | The name of the nix-shell |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[nix_shell]
disabled = true
impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) '
```
## Node.js
The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `package.json`
- The current directory contains a `.node-version` file
- The current directory contains a `.nvmrc` file
- Текущий каталог содержит каталог `node_modules`
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | A format string representing the symbol of Node.js. |
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Which extensions should trigger this module. |
| `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. |
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
| `style` | `'bold green'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `nodejs`. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. |
### Переменные
| Переменная | Пример | Описание |
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | The version of `node` |
| engines_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[nodejs]
format = 'via [🤖 $version](bold green) '
```
## OCaml
The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. |
| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. |
| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. |
| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Which extensions should trigger this module. |
| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Which filenames should trigger this module. |
| `detect_folders` | `['_opam', 'esy.lock']` | Which folders should trigger this module. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------------- | ------------ | ----------------------------------------------------------------- |
| version | `v4.10.0` | The version of `ocaml` |
| switch_name | `my-project` | The active OPAM switch |
| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[ocaml]
format = 'via [🐪 $version]($style) '
```
## Open Policy Agent
The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. |
| `detect_extensions` | `['rego']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `opa` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| version | `v0.44.0` | The version of `opa` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[opa]
format = 'via [⛑️ $version](bold red) '
```
## OpenStack
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | ----------------------------------------------- | -------------------------------------------------------------- |
| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | Формат модуля. |
| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `false` | Disables the `openstack` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[openstack]
format = 'on [$symbol$cloud(\($project\))]($style) '
style = 'bold yellow'
symbol = '☁️ '
```
## OS
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
::: warning
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
:::
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | --------------------- | ------------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | Формат модуля. |
| `style` | `"bold white"` | Стиль модуля. |
| `disabled` | `true` | Disables the `os` module. |
| `symbols` | | A table that maps each operating system to its symbol. |
`symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https://github.com/starship/starship/issues/new/choose).
```toml
# This is the default symbols table.
[os.symbols]
Alpaquita = "🔔 "
Alpine = "🏔️ "
Amazon = "🙂 "
Android = "🤖 "
Arch = "🎗️ "
Artix = "🎗️ "
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🦅 "
Gentoo = "🗜️ "
HardenedBSD = "🛡️ "
Illumos = "🐦 "
Linux = "🐧 "
Mabox = "📦 "
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄️ "
OpenBSD = "🐡 "
OpenCloudOS = "☁️ "
openEuler = "🦉 "
openSUSE = "🦎 "
OracleLinux = "🦴 "
Pop = "🍭 "
Raspbian = "🍓 "
Redhat = "🎩 "
RedHatEnterprise = "🎩 "
Redox = "🧪 "
Solus = "⛵ "
SUSE = "🦎 "
Ubuntu = "🎯 "
Unknown = "❓ "
Windows = "🪟 "
```
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------ | ------------------------------------------------------------------ |
| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |
| name | `Arch Linux` | The current operating system name |
| type | `Arch` | The current operating system type |
| codename | | The current operating system codename, if applicable |
| edition | | The current operating system edition, if applicable |
| version | | The current operating system version, if applicable |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[os]
format = "on [($name )]($style)"
style = "bold blue"
disabled = false
[os.symbols]
Windows = " "
Arch = "Arch is the best! "
```
## Версия пакета
Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` 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
- [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` 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 in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов.
### Опции
| Параметр | По умолчанию | Описание |
| ----------------- | --------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | Формат модуля. |
| `symbol` | `'📦 '` | Символ, используемый перед отображением версии пакета. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `'bold 208'` | Стиль модуля. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Отключает модуль `package`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[package]
format = 'via [🎁 $version](208 bold) '
```
## Perl
The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file
- The current directory contains a `META.json` file or `META.yml` file
- The current directory contains a `.perl-version` file
- The current directory contains a `.pl`, `.pm` or `.pod`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `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. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | --------- | ------------------------------------ |
| version | `v5.26.1` | The version of `perl` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
### Пример
```toml
# ~/.config/starship.toml
[perl]
format = 'via [🦪 $version]($style) '
```
## PHP
The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `composer.json`
- Текущий каталог содержит файл `.php-version`
- The current directory contains a `.php` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'147 bold'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `php`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v7.3.8` | The version of `php` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[php]
format = 'via [🔹 $version](147 bold) '
```
## Pijul Channel
The `pijul_channel` module shows the active channel of the repo in your current directory.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ |
| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |
| `style` | `'bold purple'` | Стиль модуля. |
| `format` | `'on [$symbol$channel]($style) '` | Формат модуля. |
| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes |
| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. |
| `disabled` | `true` | Disables the `pijul` module. |
## Pulumi
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
::: tip
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version).
:::
By default the module will be shown if any of the following conditions are met:
- The current directory contains either `Pulumi.yaml` or `Pulumi.yml`
- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false`
### Опции
| Параметр | По умолчанию | Описание |
| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `' '` | A format string shown before the Pulumi stack. |
| `style` | `'bold 5'` | Стиль модуля. |
| `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. |
| `disabled` | `false` | Disables the `pulumi` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------------- | ---------- | ------------------------------------ |
| version | `v0.12.24` | The version of `pulumi` |
| stack | `dev` | The current Pulumi stack |
| имя пользователя | `alice` | The current Pulumi username |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
#### With Pulumi Version
```toml
# ~/.config/starship.toml
[pulumi]
format = '[🛥 ($version )$stack]($style) '
```
#### Without Pulumi version
```toml
# ~/.config/starship.toml
[pulumi]
symbol = '🛥 '
format = '[$symbol$stack]($style) '
```
## PureScript
The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `spago.dhall`
- The current directory contains a file with the `.purs` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold white'` | Стиль модуля. |
| `disabled` | `false` | Disables the `purescript` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[purescript]
format = 'via [$symbol$version](bold white)'
```
## Python
The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated.
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `.python-version`
- Текущий каталог содержит файл `Pipfile`
- The current directory contains a `__init__.py` file
- Текущий каталог содержит файл `pyproject.toml`
- Текущий каталог содержит файл `requirements.txt`
- Текущий каталог содержит файл `setup.py`
- Текущий каталог содержит файл `tox.ini`
- Текущий каталог содержит файл с расширением `.py`.
- Виртуальная среда в данный момент активирована
### Опции
| Параметр | По умолчанию | Описание |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Формат модуля. |
| `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 |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
| `detect_extensions` | `['py']` | Which extensions should trigger this module |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module |
| `disabled` | `false` | Disables the `python` module. |
::: tip
The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
:::
### Переменные
| Переменная | Пример | Описание |
| ------------ | --------------- | ------------------------------------------ |
| version | `'v3.8.1'` | The version of `python` |
| symbol | `'🐍 '` | Отражает значение параметра `symbol` |
| style | `'yellow bold'` | Отражает значение параметра `style` |
| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` |
| virtualenv | `'venv'` | The current `virtualenv` name |
### Пример
```toml
# ~/.config/starship.toml
[python]
symbol = '👾 '
pyenv_version_name = true
```
```toml
# ~/.config/starship.toml
[python]
# Only use the `python3` binary to get the version.
python_binary = 'python3'
```
```toml
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
```
```toml
# ~/.config/starship.toml
[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ['./venv/bin/python', 'python', 'python3', 'python2']
```
## R
The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.R` extension.
- The current directory contains a file with the `.Rd` extension.
- The current directory contains a file with the `.Rmd` extension.
- The current directory contains a file with the `.Rproj` extension.
- The current directory contains a file with the `.Rsx` extension.
- The current directory contains a `.Rprofile` file
- The current directory contains a `.Rproj.user` folder
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'📐'` | A format string representing the symbol of R. |
| `style` | `'blue bold'` | Стиль модуля. |
| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Which extensions should trigger this module |
| `detect_files` | `['.Rprofile']` | Which filenames should trigger this module |
| `detect_folders` | `['.Rproj.user']` | Which folders should trigger this module |
| `disabled` | `false` | Disables the `r` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------- | ------------------------------------ |
| version | `v4.0.5` | The version of `R` |
| symbol | | Отражает значение параметра `symbol` |
| style | `'blue bold'` | Отражает значение параметра `style` |
### Пример
```toml
# ~/.config/starship.toml
[rlang]
format = 'with [📐 $version](blue bold) '
```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Which extensions should trigger this module. |
| `detect_files` | `['META6.json']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold 149'` | Стиль модуля. |
| `disabled` | `false` | Disables the `raku` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
### Пример
```toml
# ~/.config/starship.toml
[raku]
format = 'via [🦪 $version]($style) '
```
## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a file with `.red` or `.reds` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🔺 '` | A format string representing the symbol of Red. |
| `detect_extensions` | `['red']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'red bold'` | Стиль модуля. |
| `disabled` | `false` | Disables the `red` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v2.5.1` | The version of `red` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[red]
symbol = '🔴 '
```
## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл `Gemfile`
- Текущий каталог содержит файл `.ruby-version`
- Текущий каталог содержит файл `.rb`
- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship gets the current Ruby version by running `ruby -v`.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `['rb']` | Which extensions should trigger this module. |
| `detect_files` | `['Gemfile', '.ruby-version']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. |
| `style` | `'bold red'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `ruby`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v2.5.1` | The version of `ruby` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[ruby]
symbol = '🔺 '
```
## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл `Cargo.toml`
- Текущий каталог содержит файл с расширением `.rs`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🦀 '` | A format string representing the symbol of Rust |
| `detect_extensions` | `['rs']` | Which extensions should trigger this module. |
| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold red'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `rust`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` |
| numver | `1.51.0` | The numeric component of the `rustc` version |
| toolchain | `beta` | The toolchain version |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[rust]
format = 'via [⚙️ $version](red bold)'
```
## Scala
The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file
- The current directory contains a file with the `.scala` or `.sbt` extension
- The current directory contains a directory named `.metals`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [${symbol}(${version} )]($style)'` | Формат модуля. |
| `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. |
| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. |
| `style` | `'red dimmed'` | Стиль модуля. |
| `disabled` | `false` | Disables the `scala` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `2.13.5` | The version of `scala` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[scala]
symbol = '🌟 '
```
## Shell
The `shell` module shows an indicator for currently used shell.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ---------------------- | ------------------------- | ------------------------------------------------------------ |
| `bash_indicator` | `'bsh'` | A format string used to represent bash. |
| `fish_indicator` | `'fsh'` | A format string used to represent fish. |
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. |
| `ion_indicator` | `'ion'` | A format string used to represent ion. |
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. |
| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. |
| `nu_indicator` | `'nu'` | A format string used to represent nu. |
| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. |
| `format` | `'[$indicator]($style) '` | Формат модуля. |
| `style` | `'white bold'` | Стиль модуля. |
| `disabled` | `true` | Disables the `shell` module. |
### Переменные
| Переменная | По умолчанию | Описание |
| ---------- | ------------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Отражает значение параметра `style`. |
*: Эта переменная может использоваться только в качестве части строки style
### Примеры
```toml
# ~/.config/starship.toml
[shell]
fish_indicator = '󰈺 '
powershell_indicator = '_'
unknown_indicator = 'mystery shell'
style = 'cyan bold'
disabled = false
```
## SHLVL
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Опции
| Параметр | По умолчанию | Описание |
| --------------- | ---------------------------- | ------------------------------------------------------------------- |
| `threshold` | `2` | Display threshold. |
| `format` | `'[$symbol$shlvl]($style) '` | Формат модуля. |
| `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. |
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `repeat_offset` | `0` | Decrements number of times `symbol` is repeated by the offset value |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `true` | Disables the `shlvl` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| shlvl | `3` | The current value of `SHLVL` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = '$shlvl level(s) down'
threshold = 3
```
Using `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return status code and preceeding characters are provided by `shlvl`.
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = '[$symbol$shlvl]($style)'
repeat = true
symbol = '❯'
repeat_offset = 1
threshold = 0
```
## Singularity
The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | Формат модуля. |
| `symbol` | `''` | A format string displayed before the image name. |
| `style` | `'bold dimmed blue'` | Стиль модуля. |
| `disabled` | `false` | Disables the `singularity` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------ | ------------------------------------ |
| env | `centos.img` | The current Singularity image |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
```
## Solidity
The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.sol` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${major}.${minor}.${patch}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"S "` | A format string representing the symbol of Solidity |
| `compiler | ["solc"] | The default compiler for Solidity. |
| `detect_extensions` | `["sol"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | Стиль модуля. |
| `disabled` | `false` | Disables this module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v0.8.1` | The version of `solidity` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"
```
## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` означает без усечения. Также смотрите модуль [`directory`](#directory). |
| `symbol` | `'🅢 '` | Символ перед названием окружения. |
| `style` | `'bold blue'` | Стиль модуля. |
| `format` | `'via [$symbol$environment]($style) '` | Формат модуля. |
| `disabled` | `false` | Disables the `spack` module. |
### Переменные
| Переменная | Пример | Описание |
| ----------- | ------------ | ------------------------------------ |
| environment | `astronauts` | The current spack environment |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[spack]
format = '[$symbol$environment](dimmed blue) '
```
## Status
The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `format` | `'[$symbol$status]($style) '` | The format of the module |
| `symbol` | `'❌'` | The symbol displayed on program error |
| `success_symbol` | `''` | The symbol displayed on program success |
| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |
| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |
| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |
| `style` | `'bold red'` | Стиль модуля. |
| `recognize_signal_code` | `true` | Enable signal mapping from exit code |
| `map_symbol` | `false` | Enable symbols mapping from exit code |
| `pipestatus` | `false` | Enable pipestatus reporting |
| `pipestatus_separator` | <code>&vert;</code> | The symbol used to separate pipestatus segments (supports formatting) |
| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline |
| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments |
| `disabled` | `true` | Disables the `status` module. |
### Переменные
| Переменная | Пример | Описание |
| -------------- | ------- | ------------------------------------------------------------------------------------------ |
| status | `127` | The exit code of the last command |
| hex_status | `0x7F` | The exit code of the last command in hex |
| int | `127` | The exit code of the last command |
| common_meaning | `ERROR` | Meaning of the code if not a signal |
| signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
| maybe_int | `7` | Contains the exit code number when no meaning has been found |
| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[status]
style = 'bg:blue'
symbol = '🔴 '
success_symbol = '🟢 SUCCESS'
format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
```
## Sudo
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| --------------- | ------------------------ | ------------------------------------------------------- |
| `format` | `'[as $symbol]($style)'` | The format of the module |
| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached |
| `style` | `'bold blue'` | Стиль модуля. |
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Disables the `sudo` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[sudo]
style = 'bold green'
symbol = '👩‍💻 '
disabled = false
```
```toml
# On windows
# $HOME\.starship\config.toml
[sudo]
allow_windows = true
disabled = false
```
## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'🐦 '` | A format string representing the symbol of Swift |
| `detect_extensions` | `['swift']` | Which extensions should trigger this module. |
| `detect_files` | `['Package.swift']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'bold 202'` | Стиль модуля. |
| `disabled` | `false` | Disables the `swift` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[swift]
format = 'via [🏎 $version](red bold)'
```
## Terraform
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
::: tip
By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
:::
By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит папку `.terraform`
- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
| `style` | `'bold 105'` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `terraform`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------- | ------------------------------------ |
| version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | The current Terraform workspace |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
#### With Terraform Version
```toml
# ~/.config/starship.toml
[terraform]
format = '[🏎💨 $version$workspace]($style) '
```
#### Without Terraform version
```toml
# ~/.config/starship.toml
[terraform]
format = '[🏎💨 $workspace]($style) '
```
## Время
Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры.
::: tip
По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | The format string for the module. |
| `use_12hr` | `false` | Включить 12-часовое форматирование |
| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. |
| `style` | `'bold yellow'` | Стиль модуля времени |
| `utc_time_offset` | `'local'` | Устанавливает смещение UTC. Range from -24 &lt; x &lt; 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. |
| `disabled` | `true` | Отключает модуль `time`. |
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting.
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------- | ----------------------------------- |
| время | `13:08:10` | The current time. |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = '%T'
utc_time_offset = '-5'
time_range = '10:00:00-14:00:00'
```
## Имя пользователя
Модуль `username` показывает имя текущего пользователя. Модуль будет показан, если любое из следующих условий соблюдено:
- The current user is root/admin
- Текущий пользователь отличается от залогиненного
- Пользователь подключен к SSH-сессии
- Переменная `show_always` равна true
::: tip
SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
:::
### Опции
| Параметр | По умолчанию | Описание |
| ------------- | ----------------------- | ------------------------------------------------------- |
| `style_root` | `'bold red'` | The style used when the user is root/admin. |
| `style_user` | `'bold yellow'` | Стиль, используемый для всех пользователей, кроме root. |
| `format` | `'[$user]($style) in '` | Формат модуля. |
| `show_always` | `false` | Всегда показывать модуль `username`. |
| `disabled` | `false` | Отключает модуль `username`. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------ | ------------------------------------------------------------------------------------------- |
| `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
| `user` | `'matchai'` | The currently logged-in user ID. |
### Пример
```toml
# ~/.config/starship.toml
[username]
style_user = 'white bold'
style_root = 'black bold'
format = 'user: [$user]($style) '
disabled = false
show_always = true
```
## Vagrant
The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `Vagrantfile` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `['Vagrantfile']` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'cyan bold'` | Стиль модуля. |
| `disabled` | `false` | Disables the `vagrant` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ---------------- | ------------------------------------ |
| version | `Vagrant 2.2.10` | The version of `Vagrant` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[vagrant]
format = 'via [⍱ $version](bold white) '
```
## V
The `vlang` module shows you your currently installed version of [V](https://vlang.io/). 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)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `'V '` | A format string representing the symbol of V |
| `detect_extensions` | `['v']` | Which extensions should trigger this module. |
| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `'blue bold'` | Стиль модуля. |
| `disabled` | `false` | Disables the `vlang` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| version | `v0.2` | The version of `v` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
### Пример
```toml
# ~/.config/starship.toml
[vlang]
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.
### Опции
| Параметр | По умолчанию | Описание |
| ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | `''` | The symbol used before displaying the repository name. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `format` | `'vcsh [$symbol$repo]($style) '` | Формат модуля. |
| `disabled` | `false` | Disables the `vcsh` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------------------------------------------- | ------------------------------------ |
| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
| symbol | | Отражает значение параметра `symbol` |
| style\* | `black bold dimmed` | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[vcsh]
format = '[🆅 $repo](bold blue) '
```
## Zig
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a `.zig` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `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. |
| `detect_extensions` | `['zig']` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v0.6.0` | The version of `zig` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[zig]
symbol = '⚡️ '
```
## Custom commands
The `custom` modules show the output of some arbitrary commands.
These modules will be shown if any of the following conditions are met:
- The current directory contains a file whose name is in `detect_files`
- The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0
- The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip
Multiple custom modules can be defined by using a `.`.
:::
::: tip
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.
:::
::: tip
[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!
:::
::: warning Command output is printed unescaped to the prompt
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
:::
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
| `shell` | | [See below](#custom-command-shell) |
| `описание` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_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'` | Стиль модуля. |
| `format` | `'[$symbol($output )]($style)'` | Формат модуля. |
| `disabled` | `false` | Disables this `custom` module. |
| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |
| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. |
### Переменные
| Переменная | Описание |
| ---------- | -------------------------------------- |
| output | The output of shell command in `shell` |
| symbol | Отражает значение параметра `symbol` |
| style\* | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
#### Custom command shell
`shell` accepts a non-empty list of strings, where:
- 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.
The `command` will be passed in on stdin.
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 -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
```toml
shell = ['pwsh', '-Command', '-']
```
::: warning Make sure your custom shell configuration exits gracefully
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).
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.
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.
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.
:::
### Пример
```toml
# ~/.config/starship.toml
[custom.foo]
command = 'echo foo' # shows output of command
detect_files = ['foo'] # can specify filters but wildcards are not supported
when = ''' test "$HOME" = "$PWD" '''
format = ' transcending [$output]($style)'
[custom.time]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command', '-']
[custom.time-as-arg]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command']
use_stdin = false
```
View Git Blame Copy Permalink