starship/docs/ru-RU/config
Matan Kushner e29140a3cd
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)

* New translations README.md (German)

* New translations README.md (French)

* New translations README.md (Japanese)

* New translations README.md (Spanish)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Simplified)

* New translations README.md (Russian)

* New translations README.md (Spanish)

* New translations README.md (Spanish)

* New translations README.md (Spanish)

* New translations README.md (Spanish)

* New translations README.md (Chinese Simplified)

* New translations README.md (Chinese Traditional)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (French)

* New translations README.md (Spanish)

* New translations README.md (German)

* New translations README.md (Russian)

* New translations README.md (Japanese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Chinese Simplified)

* New translations README.md (Chinese Traditional)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (French)

* New translations README.md (Spanish)

* New translations README.md (German)

* New translations README.md (Russian)

* New translations README.md (Japanese)

* New translations README.md (French)

* New translations README.md (Japanese)

* New translations README.md (German)

* New translations README.md (Spanish)

* New translations README.md (Chinese Traditional)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Portuguese)

* New translations README.md (Chinese Simplified)

* New translations README.md (Russian)

* New translations README.md (Spanish)

* New translations README.md (Spanish)

* New translations README.md (Spanish)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (Chinese Traditional)

* New translations README.md (Chinese Traditional)

* New translations README.md (Portuguese)

* New translations README.md (Portuguese)

* New translations README.md (Chinese Simplified)

* New translations README.md (Portuguese, Brazilian)

* New translations README.md (French)

* New translations README.md (French)

* New translations README.md (Spanish)

* New translations README.md (Spanish)

* New translations README.md (German)

* New translations README.md (German)

* New translations README.md (Chinese Simplified)

* New translations README.md (Japanese)

* New translations README.md (Japanese)

* New translations README.md (Russian)

* New translations README.md (Russian)

* New translations README.md (Japanese)

* New translations README.md (Japanese)

* New translations README.md (Japanese)

* New translations README.md (Japanese)
2020-06-10 21:28:04 -04:00
..
README.md docs(i18n): new Crowdin translations (#1262) 2020-06-10 21:28:04 -04:00

Конфигурация

::: tip Подсказка

🔥 Конфигурация все еще находится в стадии разработки. Множество новых опций будут доступны в будущих версиях.

:::

Чтобы начать конфигурацию Starship, создайте следующий файл: ~/.config/starship.toml.

$ mkdir -p ~/.config && touch ~/.config/starship.toml

Вся конфигурация Starship выполняется в этом файле TOML:

# Не добавлять пустую строку в начале ввода
add_newline = false

# Поменять символ "" на символ "➜"
[character]      # Имя настраемого модуля - "character"
symbol = "➜"      # Сегменту "symbol" присваеваем значение "➜"

# Отключить модуль пакетов, полностью скрывая его из терминала
[package]
disabled = true

Вы можете изменить расположение файла starship.toml переменной окружения STARSHIP_CONFIG:

export STARSHIP_CONFIG=~/.starship

Equivalently in PowerShell (Windows) would be adding this line to your $PROFILE:

$ENV:STARSHIP_CONFIG = "$HOME\.starship"

Терминология

Модуль: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "nodejs" показывает установленную версию NodeJS на вашем компьютере, если вы находитесь в директории проекта NodeJS.

Сегмент: Меньшие подкомпоненты, составляющие модуль. Например, сегмент "symbol" в модуле "nodejs" хранит символ, показываемый перед версией NodeJS (⬢, по умолчанию).

Вот представление модуля "nodejs". В примере, "symbol" и "version" - его сегменты. Также, каждый модуль имеет префикс и суффикс, являющиеся цветом терминала по умолчанию.

[prefix]      [symbol]     [version]    [suffix]
 "via "         "⬢"        "v10.4.1"       ""

Стиль строк

В Starship, большинство модулей позволяют настроить стили отображения. Это делается записью (обычно называется style), которая представляет собой строку, определяющую конфигурацию. Ниже приведены несколько примеров стилей строк, а также, их действия. Подробнее о полном синтаксисе можно прочитать в расширенном разделе конфигурации.

  • "fg:green bg:blue" устанавливает зеленый текст на синем фоне
  • "bg:blue fg:bright-green" устанавливает ярко-зеленый текст на синем фоне
  • "bold fg:27" устанавливает жирный текст с цветом ANSI 27
  • "underline bg:#bf5700" устанавливает подчёркиваемый текст цвета сожженного апельсина
  • "bold italic fg:purple" устанавливает жирный фиолетовый текст
  • "" выключает все стили

Обратите внимание на то, что, вид стиля зависит от вашего эмулятора терминала. Например, некоторые эмуляторы терминала будут использовать яркие цвета вместо жирного текста, и некоторые цветовые темы используют одинаковые значение для обычных и ярких цветов. Также, чтобы получить курсивный текст, ваш терминал должен поддерживать курсив.

Командная строка

Ниже находится список опций, применяющихся для всей командной строки.

Опции

Переменная По умолчанию Описание
add_newline true Добавление пустой строки перед началом командной строки.
prompt_order ссылка Настройка порядка появления модулей командной строки.
scan_timeout 30 Тайм-аут запуска сканирования файлов (в миллисекундах).

Пример

# ~/.config/starship.toml

# Не добавлять пустую строку перед началом командной строки
add_newline = false
# Перезаписать default_prompt_order и использовать пользовательский prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Ждать 10 миллисекунд перед запуском сканирования файлов.
scan_timeout = 10

Порядок модулей командной строки по умолчанию

По умолчанию, prompt_order определеят порядок появления модулей командной строки, если prompt_order пустой или не объявлен. Значение по умолчанию:

prompt_order = [
    "username",
    "hostname",
    "kubernetes",
    "directory",
    "git_branch",
    "git_commit",
    "git_state",
    "git_status",
    "hg_branch",
    "docker_context",
    "package",
    "dotnet",
    "elixir",
    "elm",
    "erlang",
    "golang",
    "haskell",
    "java",
    "julia",
    "nim",
    "nodejs",
    "ocaml",
    "php",
    "purescript",
    "python",
    "ruby",
    "rust",
    "terraform",
    "zig",
    "nix_shell",
    "conda",
    "memory_usage",
    "aws",
    "env_var",
    "crystal",
    "cmd_duration",
    "custom",
    "line_break",
    "jobs",
    "battery",
    "time",
    "character",
]

AWS

Модуль aws показывает текущий регион и профиль AWS. Основано на AWS_REGION, AWS_DEFAULT_REGION, и AWS_PROFILE переменных окружения и файле~/.aws/config.

При использовании aws-vault профиль читается из переменной среды AWS_VAULT.

Опции

Переменная По умолчанию Описание
symbol "☁️ " Символ перед отображением текущего профиля AWS.
displayed_items all Выбор элементов. Возможные значения [all, profile, region]
region_aliases Таблица региона псевдонимов, отображаемая вместе с именем AWS.
style "bold yellow" Стиль модуля.
disabled false Отключение модуля AWS.

Пример

# ~/.config/starship.toml

[aws]
style = "bold blue"
symbol = "🅰 "
displayed_items = "region"
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

Батарея

Модуль battery показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%.

Опции

Переменная По умолчанию Описание
full_symbol "•" Символ, отображаемый при полной батарее.
charging_symbol "⇡" Символ, показываемый при зарядке аккумулятора.
discharging_symbol "⇣" Символ, показываемый при разрядке аккумулятора.
display link Порог отображения и стиль для модуля.
disabled false Отключает модуль battery.
Также, есть опции для некоторых нетипичных состояний батареи.
Переменная Описание
unknown_symbol Символ, отображаемый при неизвестном состоянии батареи.
empty_symbol Символ, отображаемый при пустом состоянии батареи.

Примечание: Индикатор батареи будет скрыт при состоянии unknown или empty, если вы не указали параметр в настройках.

Пример

# ~/.config/starship.toml

[battery]
full_symbol = "🔋"
charging_symbol = "⚡️"
discharging_symbol = "💀"

Отображение батареи

Параметр display используется для определения того, когда индикатор батареи должен быть показан (threshhold) и как он выглядит (style). Если display не предоставлено. Значение по умолчанию:

[[battery.display]]
threshold = 10
style = "bold red"

Опции

Опция display представляет собой массив следующей таблицы.

Переменная Описание
threshold Верхняя граница опции отображения.
style Используемый стиль, если используется опция отображения.

Пример

[[battery.display]] # стиль "bold red" (жирный красный) если заряд между 0% и 10%
threshold = 10
style = "bold red"

[[battery.display]] # стиль "bold yellow" (жирный желтый) если заряд между 10% и 30%
threshold = 30
style = "bold yellow"

# когда заряд батареи больше 30%, индикатор батареи скрыт

Символ

Модуль character показывает символ (обычно, стрелка) рядом с вводимым текстом в терминале.

Символ показывает, была ли последняя команда успешной или нет. Это возможно двумя способами: меняя цвет (красный/зеленый) или изменяя его форму (/✖). Последнее будет исполняться только в том случае, если переменной use_symbol_for_status установлено значение true.

Опции

Переменная По умолчанию Описание
symbol "" Символ, используемый перед вводом текста в командной строке.
error_symbol "✖" Символ, используемый перед вводом текста, если предыдущая команда не удалась.
use_symbol_for_status false Показывает статус ошибки путем изменения символа.
vicmd_symbol "" Символ, используемый перед вводом текста в строке, если командная строка находится в нормальном режиме vim.
style_success "bold green" Используемый стиль, если последняя команда была успешной.
style_failure "bold red" Используемый стиль, если последняя команда была не успешной.
disabled false Отключает модуль character.

Пример

# ~/.config/starship.toml

[character]
symbol = "➜"
error_symbol = "✗"
use_symbol_for_status = true

Длительность команды

Модуль cmd_duration показывает время исполнения последней команды. Модуль будет показан только, если команда заняла более двух секунд, или если задан параметр min_time.

::: warning Не подключайте ловушку DEBUG к Bash

Если вы испоьзуете Starship в bash, не подключайте ловушку DEBUG после запуска eval $(starship init $0), иначе этот модуль сломается.

:::

Пользователи Bash, которым нужна функциональность, подобная preexec, могут использовать фреймворк bash_preexec от rcaloras. Просто определите массивы preexec_functions и precmd_functions перед запуском eval $(starship init $0), а затем продолжайте нормально.

Опции

Переменная По умолчанию Описание
min_time 2_000 Кратчайшая продолжительность для показа времени (в миллисекундах).
show_milliseconds false Показывать миллисекунды в дополнение к секундам в продолжительности.
prefix took Префикс, отображаемый перед продолжительностью команды.
style "bold yellow" Стиль модуля.
disabled false Отключает модуль cmd_duration.

Пример

# ~/.config/starship.toml

[cmd_duration]
min_time = 500
prefix = "underwent "

Конда

Модуль conda показывает текущее окружение conda, если $CONDA_DEFAULT_ENV присвоено значение.

::: tip

Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить conda config --set changeps1 False.

:::

Опции

Переменная По умолчанию Описание
truncation_length 1 Количество каталогов, в которых путь к окружению должен быть усечен, если окружение было создано через conda create -p [path]. 0 означает без усечения. Также смотрите модуль directory.
symbol "C " Символ перед названием окружения.
style "bold green" Стиль модуля.
disabled false Отключает модуль conda.

Пример

# ~/.config/starship.toml

[conda]
style = "dimmed green"

Crystal

Модуль crystal показывает установленную версию Crystal. Модуль будет показан, если любое из следующих условий соблюдено:

  • Текущий каталог содержит файл shard.yml
  • Текущий каталог содержит файл .cr

Опции

Переменная По умолчанию Описание
symbol "🔮 " Символ, используемый перед отображением версии crystal.
style "bold red" Стиль модуля.
disabled false Отключает модуль crystal.

Пример

# ~/.config/starship.toml

[crystal]
symbol = "✨ "
style = "bold blue"

Каталог

Модуль directory показывает путь к вашей текущей директории, усеченной до трех родительских папок. Ваш каталог также будет отсечен до корня git репозитория, в котором вы находитесь.

При использовании стиля оболочки fish, вместо скрытия усеченного каталога, вы увидите укороченное имя каталога, зависимое от числа символов вы установите для этой опции.

Например, возьмем ~/Dev/Nix/nixpkgs/pkgs где nixpkgs является корневым репозиторием, и в опции установлено 1. Вы увидите ~/D/N/nixpkgs/pkgs, а до этого было бы nixpkgs/pkgs.

Опции

Переменная По умолчанию Описание
truncation_length 3 Количество родительских папок, к которым должен быть усечен текущий каталог.
truncate_to_repo true Следует или нет обрезать до корня репозитория git, в котором вы находитесь.
prefix "in " Префикс, отображаемый перед папкой.
style "bold cyan" Стиль модуля.
disabled false Отключает модуль directory.
Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога.
Переменная По умолчанию Описание
substitutions A table of substitutions to be made to the path.
fish_style_pwd_dir_length 0 The number of characters to use when applying fish shell pwd path logic.
use_logical_path true Displays the logical path provided by the shell (PWD) instead of the path from the OS.

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.

[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"

fish_style_pwd_dir_length interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll, which would normally be displayed as 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.

Пример

# ~/.config/starship.toml

[directory]
truncation_length = 8

Контекст Docker

The docker_context module shows the currently active Docker context if it's not set to default.

Опции

Переменная По умолчанию Описание
symbol "🐳 " The symbol used before displaying the Docker context .
only_with_files false Only show when there's a docker-compose.yml or Dockerfile in the current directory.
style "bold blue" Стиль модуля.
disabled true Disables the docker_context module.

Пример

# ~/.config/starship.toml

[docker_context]
symbol = "🐋 "

Dotnet

The dotnet module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.

This module will only be shown in your prompt when one of the following files are present in the current directory: global.json, project.json, *.sln, *.csproj, *.fsproj, *.xproj. You'll also need the .NET Core command-line tools installed in order to use it correctly.

Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false in the module options.

Опции

Переменная По умолчанию Описание
symbol "•NET " Символ перед отображением текущей версии dotnet.
heuristic true Использовать быстрое определение версии, для сохранения скорости.
style "bold blue" Стиль модуля.
disabled false Отключает модуль dotnet.

Пример

# ~/.config/starship.toml

[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false

Elixir

The elixir module shows the currently installed version of Elixir and Erlang/OTP. Модуль будет показан, если любое из следующих условий соблюдено:

  • Текущий каталог содержит файл mix.exs.

Опции

Переменная По умолчанию Описание
symbol "💧 " Символ, используемый перед отображением версии Elixir/Erlang.
style "bold purple" Стиль модуля.
disabled false Отключает модуль elixir.

Пример

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

Elm

The elm module shows the currently installed version of Elm. Модуль будет показан, если любое из следующих условий соблюдено:

  • Текущий каталог содержит файл elm.json
  • Текущий каталог содержит файл elm-package.json
  • Текущий каталог содержит файл .elm-version
  • Текущий каталог содержит папку elm-stuff
  • Текущий каталог содержит файлы *.elm

Опции

Переменная По умолчанию Описание
symbol "🌳 " Символ, используемый перед отображением версии Elm.
style "bold cyan" Стиль модуля.
disabled false Отключает модуль elm.

Пример

# ~/.config/starship.toml

[elm]
symbol = " "

Переменная Окружения

The env_var module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:

  • Опция variable соответствует существующей переменной среды
  • Опция variable не определена, но определена опция default

Опции

Переменная По умолчанию Описание
symbol Символ, используемый перед отображением значения переменной.
variable Отображаемая переменная окружения.
default Значение отображаемое, когда выбранная переменная не определена.
prefix "" Префикс, отображаемый, непосредственно перед значением переменной.
suffix "" Префикс, отображаемый, непосредственно после значением переменной.
style "dimmed bold black" Стиль модуля.
disabled false Отключает модуль env_var.

Пример

# ~/.config/starship.toml

[env_var]
variable = "SHELL"
default = "unknown shell"

Erlang

The erlang module shows the currently installed version of Erlang/OTP. Модуль будет показан, если любое из следующих условий соблюдено:

  • Текущий каталог содержит файл rebar.config.
  • Текущий каталог содержит файл erlang.mk.

Опции

Переменная По умолчанию Описание
symbol "🖧 " The symbol used before displaying the version of Erlang.
style bold red The style for this module.
disabled false Disables the erlang module.

Пример

# ~/.config/starship.toml

[erlang]
symbol = "e "

Ветвь Git

The git_branch module shows the active branch of the repo in your current directory.

Опции

Переменная По умолчанию Описание
symbol " " Символ, используемый перед именем ветки репозитория в вашей текущей директории.
truncation_length 2^63 - 1 Отрезает ветку git до X графемов
truncation_symbol "…" Символ, используемый для обозначения усечения названия ветки. Вы можете использовать "", чтобы не видеть символ
style "bold purple" Стиль модуля.
disabled false Отключает модуль git_branch.

Пример

# ~/.config/starship.toml

[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""

Коммит Git

The git_commit module shows the current commit hash of the repo in your current directory.

Опции

Переменная По умолчанию Описание
commit_hash_length 7 Длина отображаемого хэша коммита git.
prefix "(" Префикс, отображаемый сразу после коммита.
suffix ")" Суффикс, отображаемый сразу после коммита git.
style "bold green" Стиль модуля.
only_detached true Показывать хэш коммита git, только находясь в состоянии отделённой HEAD
disabled false Отключает модуль git_commit.

Пример

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4

Состояние Git

The git_state module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.

Опции

Переменная По умолчанию Описание
rebase "REBASING" Текст, отображаемый в процессе операции rebase.
merge "MERGING" Текст, отображаемый в процессе операции merge.
revert "REVERTING" Текст, отображаемый в процессе операции revert.
cherry_pick "CHERRY-PICKING" Текст, отображаемый в процессе операции cherry-pick.
bisect "BISECTING" Текст, отображаемый в процессе операции bisect.
am "AM" Текст, отображаемый в процессе операции apply-mailbox (git am).
am_or_rebase "AM/REBASE" Текст, отображаемый, когда выполняется неоднозначный процесс apply-mailbox или rebase.
progress_divider "/" Символ или текст, который будет разделять текущую и общую сумму прогресса. (напр., " из ", для "3 из 10")
style "bold yellow" Стиль модуля.
disabled false Отключает модуль git_state.

Пример

# ~/.config/starship.toml

[git_state]
progress_divider = " of "
cherry_pick = "🍒 PICKING"

Статус Git

The git_status module shows symbols representing the state of the repo in your current directory.

Опции

Переменная По умолчанию Описание
conflicted "=" Эта ветка имеет конфликты слияния.
conflicted_count ссылка Оформленно показывать количество конфликтов.
ahead "⇡" Эта ветка впереди отслеживаемой ветви.
behind "⇣" Эта ветка позади отслеживаемой ветви.
diverged "⇕" Эта ветка расходится от отслеживаемой ветки.
untracked "?" В рабочей директории есть неотслеженные файлы.
untracked_count ссылка Показывать в стиле количество неотслеженных файлов.
stashed "$" Для локального репозитория существует тайник.
stashed_count ссылка Оформленно показывать количество тайников.
modified "!" В рабочем директории есть изменения файлов.
modified_count ссылка Оформленно показывать количество измененных файлов.
staged "+" В промежуточную область добавлен новый файл.
staged_count ссылка Оформленно показывать количество файлов в промежуточной области.
renamed "»" В промежуточную область добавлен переименованный файл.
renamed_count ссылка Оформленно показывать количество переименованных файлов.
deleted "✘" Удаление файла было добавлено в промежуточную область.
deleted_count ссылка Оформленно показывать количество удаленных файлов.
show_sync_count false Показывать счетчик впереди/позади для отслеживаемой ветки.
prefix [ Префикс для отображения сразу перед статусом git.
suffix ] Суффикс, отображаемый сразу после статуса git.
style "bold red" Стиль модуля.
disabled false Отключает модуль git_status.

Счетчик статуса Git

Переменная По умолчанию Описание
enabled false Показать количество файлов
style При желании, можно оформлять счетчик не так, как модуль

Пример

# ~/.config/starship.toml

[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"

Golang

The golang module shows the currently installed version of Golang. Модуль будет показан, если любое из следующих условий соблюдено:

  • Текущий каталог содержит файл go.mod
  • Текущий каталог содержит файл go.sum
  • Текущий каталог содержит файл glide.yaml
  • Текущий каталог содержит файл Gopkg.yml
  • Текущий каталог содержит файл Gopkg.lock
  • The current directory contains a .go-version file
  • Текущий каталог содержит папку Godeps
  • Текущий каталог содержит файл с расширением .go

Опции

Переменная По умолчанию Описание
symbol "🐹 " Символ, используемый перед отображением версии Golang.
style "bold cyan" Стиль модуля.
disabled false Отключает модуль golang.

Пример

# ~/.config/starship.toml

[golang]
symbol = "🏎💨 "

Haskell

The haskell module shows the currently installed version of Haskell Stack version. Модуль будет показан, если любое из следующих условий соблюдено:

  • Текущий каталог содержит файл stack.yaml

Опции

Переменная По умолчанию Описание
symbol "λ " Символ перед отображением текущей версии Haskell.
style "bold red" Стиль модуля.
disabled false Отключает модуль haskell.

Пример

# ~/.config/starship.toml

[haskell]
symbol = " "

Имя хоста

The hostname module shows the system hostname.

Опции

Переменная По умолчанию Описание
ssh_only true Показывать имя хоста только при подключении к SSH-сессии.
prefix "" Префикс, отображаемый непосредственно перед именем хоста.
suffix "" Суффикс, отображаемый непосредственно перед именем хоста.
trim_at "." Строка, по которую имя хоста будет сокращено после первого совпадения. "." остановится после первой точки. "" отключит любое усечение
style "bold dimmed green" Стиль модуля.
disabled false Отключает модуль hostname.

Пример

# ~/.config/starship.toml

[hostname]
ssh_only = false
prefix = "⟪"
suffix = "⟫"
trim_at = ".companyname.com"
disabled = false

Java

The java module shows the currently installed version of Java. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a pom.xml, build.gradle.kts, build.sbt or .java-version file
  • The current directory contains a file with the .java, .class, .gradle or .jar extension

Опции

Переменная По умолчанию Описание
symbol "☕ " Символ, используемый перед отображением версии Java.
style "dimmed red" Стиль модуля.
disabled false Отключает модуль java.

Пример

# ~/.config/starship.toml

[java]
symbol = "🌟 "

Задачи

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. 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.

Опции

Переменная По умолчанию Описание
symbol "✦" Символ, используемый перед отображением количества работ.
threshold 1 Показывать количество задач, если превышено.
style "bold blue" Стиль модуля.
disabled false Отключает модуль jobs.

Пример

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

Julia

The julia module shows the currently installed version of Julia. Модуль будет показан, если любое из следующих условий соблюдено:

  • 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

Опции

Переменная По умолчанию Описание
symbol "ஃ " The symbol used before displaying the version of Julia.
style "bold purple" Стиль модуля.
disabled false Disables the julia module.

Пример

# ~/.config/starship.toml

[julia]
symbol = "∴ "

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.

::: tip Подсказка

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Опции

Переменная По умолчанию Описание
symbol "☸ " Символ, используемый перед отображением информации о Cluster.
context_aliases Table of context aliases to display
style "bold blue" Стиль модуля.
disabled true Отключает модуль kubernetes

Пример

# ~/.config/starship.toml

[kubernetes]
symbol = "⛵ "
style = "dimmed green"
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"

Перевод Строки

The line_break module separates the prompt into two lines.

Опции

Переменная По умолчанию Описание
disabled false Отключает модуль line_break, отображая командную строку в одну строку.

Пример

# ~/.config/starship.toml

[line_break]
disabled = true

Использование памяти

The memory_usage module shows current system memory and swap usage.

By default the swap usage is displayed if the total system swap is non-zero.

::: tip Подсказка

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Опции

Переменная По умолчанию Описание
show_percentage false Отображать использование памяти в процентах от доступной памяти.
show_swap true Отображать использование подкачки, если общая сумма подкачки не равна нулю.
threshold 75 Скрывать использование памяти, если она не превышает этот процент.
symbol "🐏 " Символ, используемый перед отображением использования памяти.
separator `" "`
style "bold dimmed white" Стиль модуля.
disabled true Отключает модуль memory_usage.

Пример

# ~/.config/starship.toml

[memory_usage]
disabled = false
show_percentage = true
show_swap = true
threshold = -1
symbol = " "
separator = "/"
style = "bold dimmed green"

Ветка Mercurial

The hg_branch module shows the active branch of the repo in your current directory.

Опции

Переменная По умолчанию Описание
symbol " " Символ, используемый перед закладкой hg или именем ветви репозитория в текущем каталоге.
truncation_length 2^63 - 1 Обрезает имя ветки hg до X графемов
truncation_symbol "…" Символ, используемый для обозначения усечения названия ветки.
style "bold purple" Стиль модуля.
disabled true Отключает модуль hg_branch.

Пример

# ~/.config/starship.toml

[hg_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""

Nim

The nim module shows the currently installed version of Nim. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a nim.cfg file
  • The current directory contains a file with the .nim extension
  • The current directory contains a file with the .nims extension
  • The current directory contains a file with the .nimble extension

Опции

Переменная По умолчанию Описание
symbol "👑 " The symbol used before displaying the version of Nim.
style "bold yellow" Стиль модуля.
disabled false Disables the nim module.

Пример

# ~/.config/starship.toml

[nim]
style = "yellow"
symbol = "🎣 "

Nix-shell

The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.

Опции

Переменная По умолчанию Описание
use_name false Display the name of the nix-shell.
impure_msg "impure" Customize the "impure" msg.
pure_msg "pure" Customize the "pure" msg.
symbol "❄️ " The symbol used before displaying the shell name.
style "bold blue" Стиль модуля.
disabled false Disables the nix_shell module.

Пример

# ~/.config/starship.toml

[nix_shell]
disabled = true
use_name = true
impure_msg = "impure shell"
pure_msg = "pure shell"
symbol = "☃️  "

NodeJS

The nodejs module shows the currently installed version of NodeJS. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a package.json file
  • The current directory contains a .node-version file
  • The current directory contains a node_modules directory
  • The current directory contains a file with the .js extension

Опции

Переменная По умолчанию Описание
symbol "⬢ " The symbol used before displaying the version of NodeJS.
style "bold green" Стиль модуля.
disabled false Disables the nodejs module.

Пример

# ~/.config/starship.toml

[nodejs]
symbol = "🤖 "

Package Version

The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm, cargo, poetry, composer, gradle, julia and mix packages.

  • npm The npm package version is extracted from the package.json present in the current directory
  • cargo The cargo package version is extracted from the Cargo.toml present in the current directory
  • poetry The poetry package version is extracted from the pyproject.toml present in the current directory
  • composer The composer package version is extracted from the composer.json present in the current directory
  • gradle The gradle package version is extracted from the build.gradle present
  • julia - The package version is extracted from the Project.toml present
  • mix - The mix package version is extracted from the mix.exs present

⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов.

Опции

Переменная По умолчанию Описание
symbol "📦 " The symbol used before displaying the version the package.
style "bold 208" Стиль модуля.
display_private false Enable displaying version for packages marked as private.
disabled false Disables the package module.

Пример

# ~/.config/starship.toml

[package]
symbol = "🎁 "

OCaml

The ocaml module shows the currently installed version of OCaml. Модуль будет показан, если любое из следующих условий соблюдено:

  • 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

Опции

Переменная По умолчанию Описание
symbol "🐫 " The symbol used before displaying the version of OCaml.
style "bold yellow" Стиль модуля.
disabled false Disables the ocaml module.

Пример

# ~/.config/starship.toml

[ocaml]
symbol = "🐪 "

PHP

The php module shows the currently installed version of PHP. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a composer.json file
  • The current directory contains a .php-version file
  • The current directory contains a .php file

Опции

Переменная По умолчанию Описание
symbol "🐘 " The symbol used before displaying the version of PHP.
style "bold 147" Стиль модуля.
disabled false Disables the php module.

Пример

# ~/.config/starship.toml

[php]
symbol = "🔹 "

Python

The python module shows the currently installed version of Python and the current Python virtual environment 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.

Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a .python-version file
  • The current directory contains a requirements.txt file
  • The current directory contains a pyproject.toml file
  • The current directory contains a file with the .py extension (and scan_for_pyfiles is true)
  • The current directory contains a Pipfile file
  • The current directory contains a tox.ini file
  • The current directory contains a setup.py file
  • The current directory contains a __init__.py file
  • A virtual environment is currently activated

Опции

Переменная По умолчанию Описание
symbol "🐍 " The symbol used before displaying the version of Python.
pyenv_version_name false Use pyenv to get Python version
pyenv_prefix "pyenv " Prefix before pyenv version display (default display is pyenv MY_VERSION)
scan_for_pyfiles true If false, Python files in the current directory will not show this module.
style "bold yellow" Стиль модуля.
disabled false Disables the python module.

Пример

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true
pyenv_prefix = "foo "

Ruby

The ruby module shows the currently installed version of Ruby. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a Gemfile file
  • The current directory contains a .ruby-version file
  • The current directory contains a .rb file

Опции

Переменная По умолчанию Описание
symbol "💎 " The symbol used before displaying the version of Ruby.
style "bold red" Стиль модуля.
disabled false Disables the ruby module.

Пример

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

The rust module shows the currently installed version of Rust. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a Cargo.toml file
  • The current directory contains a file with the .rs extension

Опции

Переменная По умолчанию Описание
symbol "🦀 " The symbol used before displaying the version of Rust.
style "bold red" Стиль модуля.
disabled false Disables the rust module.

Пример

# ~/.config/starship.toml

[rust]
symbol = "⚙️ "

Singularity

The singularity module shows the current singularity image, if inside a container and $SINGULARITY_NAME is set.

Опции

Переменная По умолчанию Описание
label "" Prefix before the image name display.
prefix "[" Prefix to display immediately before image name.
suffix "]" Suffix to display immediately after image name.
symbol "" The symbol used before the image name.
style "bold dimmed blue" Стиль модуля.
disabled false Disables the singularity module.

Пример

# ~/.config/starship.toml

[singularity]
symbol = "📦 "

Terraform

The terraform module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a .terraform folder
  • Current directory contains a file with the .tf extension

Опции

Переменная По умолчанию Описание
symbol "💠 " The symbol used before displaying the terraform workspace.
show_version false Shows the terraform version. Very slow on large workspaces.
style "bold 105" Стиль модуля.
disabled false Disables the terraform module.

Пример

# ~/.config/starship.toml

[terraform]
symbol = "🏎💨 "

Time

The time module shows the current local time. The format configuration value is used by the chrono crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.

::: tip Подсказка

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Опции

Переменная По умолчанию Описание
use_12hr false Enables 12 hour formatting.
format see below The chrono format string used to format the time.
style "bold yellow" The style for the module time.
utc_time_offset "local" Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
disabled true Disables the time module.
time_range "-" Sets the time range during which the module will be shown. Times must be specified in 24-hours format

If use_12hr is true, then format defaults to "%r". Otherwise, it defaults to "%T". Manually setting format will override the use_12hr setting.

Пример

# ~/.config/starship.toml

[time]
disabled = false
format = "🕙[ %T ]"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"

Username

The username module shows active user's username. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current user is root
  • The current user isn't the same as the one that is logged in
  • The user is currently connected as an SSH session
  • The variable show_always is set to true

Опции

Переменная По умолчанию Описание
style_root "bold red" The style used when the user is root.
style_user "bold yellow" The style used for non-root users.
show_always false Always shows the username module.
disabled false Disables the username module.

Пример

# ~/.config/starship.toml

[username]
disabled = true

Zig

The zig module shows the currently installed version of Zig. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a .zig file

Опции

Переменная По умолчанию Описание
symbol "↯ " The symbol used before displaying the version of Zig.
style "bold yellow" Стиль модуля.
disabled false Disables the zig module.

Пример

# ~/.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 files
  • The current directory contains a directory whose name is in directories
  • The current directory contains a file whose extension is in extensions
  • The when command returns 0

::: tip Подсказка

Multiple custom modules can be defined by using a ..

:::

::: tip Подсказка

The order in which custom modules are shown can be individually set by setting custom.foo in prompt_order. By default, the custom module will simply show all custom modules in the order they were defined.

:::

Опции

Переменная По умолчанию Описание
command The command whose output should be printed.
when A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code.
shell See below
description "<custom module>" The description of the module that is shown when running starship explain.
files [] The files that will be searched in the working directory for a match.
directories [] The directories that will be searched in the working directory for a match.
extensions [] The extensions that will be searched in the working directory for a match.
symbol "" The symbol used before displaying the command output.
style "bold green" Стиль модуля.
prefix "" Prefix to display immediately before the command output.
suffix "" Suffix to display immediately after the command output.
disabled false Disables this custom module.

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.

If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -. This behavior can be avoided by explicitly passing arguments to the shell, e.g.

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 with shell details and starship configuration if you hit such scenario.

:::

Пример

# ~/.config/starship.toml

[custom.foo]
command = "echo foo"  # shows output of command
files = ["foo"]       # can specify filters
when = """ test "$HOME" == "$PWD" """
prefix = " transcending "

[custom.time]
command = "time /T"
files = ["*.pst"]
prefix = "transcending "
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]

PureScript

The purescript module shows the currently installed version of PureScript version. Модуль будет показан, если любое из следующих условий соблюдено:

  • The current directory contains a spago.dhall file
  • The current directory contains a *.purs files

Опции

Переменная По умолчанию Описание
symbol "<=> " The symbol used before displaying the version of PureScript.
style "bold white" Стиль модуля.
disabled false Disables the purescript module.

Пример

# ~/.config/starship.toml

[purescript]
symbol = "<=> "