| .. | ||
| README.md | ||
Конфигурация
::: 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
Терминология
Модуль: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "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",
"package",
"dotnet",
"elixir",
"elm",
"golang",
"haskell",
"java",
"nodejs",
"php",
"python",
"ruby",
"rust",
"terraform",
"nix_shell",
"conda",
"memory_usage",
"aws",
"env_var",
"crystal",
"cmd_duration",
"line_break",
"jobs",
"battery",
"time",
"character",
]
AWS
Модуль aws показывает текущий регион и профиль AWS. Основано на AWS_REGION, AWS_DEFAULT_REGION, и AWS_PROFILE переменных окружения и файле~/.aws/config.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
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
The crystal module shows the currently installed version of Crystal. Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a
shard.ymlfile - The current directory contains a
.crfile
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🔮 " |
The symbol used before displaying the version of crystal. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Disables the crystal module. |
Пример
# ~/.config/starship.toml
[crystal]
symbol = "✨ "
style = "bold blue"
Directory
The directory module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
For example, given ~/Dev/Nix/nixpkgs/pkgs where nixpkgs is the repo root, and the option set to 1. You will now see ~/D/N/nixpkgs/pkgs, whereas before it would have been nixpkgs/pkgs.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
truncation_length |
3 |
The number of parent folders that the current directory should be truncated to. |
truncate_to_repo |
true |
Whether or not to truncate to the root of the git repo that you're currently in. |
prefix |
"in " |
Prefix to display immediately before the directory. |
style |
"bold cyan" |
Стиль модуля. |
disabled |
false |
Disables the directory module. |
This module has a few advanced configuration options that control how the directory is displayed.
| Переменная | По умолчанию | Описание |
|---|---|---|
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. |
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
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 " |
The symbol used before displaying the version of dotnet. |
heuristic |
true |
Use faster version detection to keep starship snappy. |
style |
"bold blue" |
Стиль модуля. |
disabled |
false |
Disables the dotnet module. |
Пример
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
Elixir
The elixir module shows the currently installed version of Elixir and Erlang/OTP. Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a
mix.exsfile.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"💧 " |
The symbol used before displaying the version of Elixir/Erlang. |
disabled |
false |
Disables the elixir module. |
Пример
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
Elm
The elm module shows the currently installed version of Elm. Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a
elm.jsonfile - The current directory contains a
elm-package.jsonfile - The current directory contains a
elm-stufffolder - The current directory contains a
*.elmfiles
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🌳 " |
The symbol used before displaying the version of Elm. |
style |
"bold cyan" |
Стиль модуля. |
disabled |
false |
Disables the elm module. |
Пример
# ~/.config/starship.toml
[elm]
symbol = " "
Environment Variable
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:
- The
variableconfiguration option matches an existing environment variable - The
variableconfiguration option is not defined, but thedefaultconfiguration option is
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
The symbol used before displaying the variable value. | |
variable |
The environment variable to be displayed. | |
default |
The default value to be displayed when the selected variable is not defined. | |
prefix |
"" |
Prefix to display immediately before the variable value. |
suffix |
"" |
Suffix to display immediately after the variable value. |
style |
"dimmed black" |
Стиль модуля. |
disabled |
false |
Disables the env_var module. |
Пример
# ~/.config/starship.toml
[env_var]
variable = "SHELL"
default = "unknown shell"
Git Branch
The git_branch module shows the active branch of the repo in your current directory.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
" " |
The symbol used before the branch name of the repo in your current directory. |
truncation_length |
2^63 - 1 |
Truncates a git branch to X graphemes |
truncation_symbol |
"…" |
The symbol used to indicate a branch name was truncated. You can use "" for no symbol |
style |
"bold purple" |
Стиль модуля. |
disabled |
false |
Disables the git_branch module. |
Пример
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
Git Commit
The git_commit module shows the current commit hash of the repo in your current directory.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
commit_hash_length |
7 |
The length of the displayed git commit hash. |
prefix |
"(" |
Prefix to display immediately before git commit. |
suffix |
")" |
Suffix to display immediately after git commit. |
style |
"bold green" |
Стиль модуля. |
only_detached |
true |
Only show git commit hash when in detached HEAD state |
disabled |
false |
Disables the git_commit module. |
Пример
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
Git State
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" |
The text displayed when a rebase is in progress. |
merge |
"MERGING" |
The text displayed when a merge is in progress. |
revert |
"REVERTING" |
The text displayed when a revert is in progress. |
cherry_pick |
"CHERRY-PICKING" |
The text displayed when a cherry-pick is in progress. |
bisect |
"BISECTING" |
The text displayed when a bisect is in progress. |
am |
"AM" |
The text displayed when an apply-mailbox (git am) is in progress. |
am_or_rebase |
"AM/REBASE" |
The text displayed when an ambiguous apply-mailbox or rebase is in progress. |
progress_divider |
"/" |
The symbol or text which will separate the current and total progress amounts. (e.g., " of ", for "3 of 10") |
style |
"bold yellow" |
Стиль модуля. |
disabled |
false |
Disables the git_state module. |
Пример
# ~/.config/starship.toml
[git_state]
progress_divider = " of "
cherry_pick = "🍒 PICKING"
Git Status
The git_status module shows symbols representing the state of the repo in your current directory.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
conflicted |
"=" |
This branch has merge conflicts. |
conflicted_count |
ссылка | Show and style the number of conflicts. |
ahead |
"⇡" |
This branch is ahead of the branch being tracked. |
behind |
"⇣" |
This branch is behind of the branch being tracked. |
diverged |
"⇕" |
This branch has diverged from the branch being tracked. |
untracked |
"?" |
There are untracked files in the working directory. |
untracked_count |
ссылка | Show and style the number of untracked files. |
stashed |
"$" |
A stash exists for the local repository. |
stashed_count |
ссылка | Show and style the number of stashes. |
modified |
"!" |
There are file modifications in the working directory. |
modified_count |
ссылка | Show and style the number of modified files. |
staged |
"+" |
A new file has been added to the staging area. |
staged_count |
ссылка | Show and style the number of files staged files. |
renamed |
"»" |
A renamed file has been added to the staging area. |
renamed_count |
ссылка | Show and style the number of renamed files. |
deleted |
"✘" |
A file's deletion has been added to the staging area. |
deleted_count |
ссылка | Show and style the number of deleted files. |
show_sync_count |
false |
Show ahead/behind count of the branch being tracked. |
prefix |
[ |
Prefix to display immediately before git status. |
suffix |
] |
Suffix to display immediately after git status. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Disables the git_status module. |
Счетчик статуса Git
| Переменная | По умолчанию | Описание |
|---|---|---|
enabled |
false |
Show the number of files |
style |
Optionally style the count differently than the module |
Пример
# ~/.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. Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a
go.modfile - The current directory contains a
go.sumfile - The current directory contains a
glide.yamlfile - The current directory contains a
Gopkg.ymlfile - The current directory contains a
Gopkg.lockfile - The current directory contains a
Godepsdirectory - The current directory contains a file with the
.goextension
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🐹 " |
The symbol used before displaying the version of Golang. |
style |
"bold cyan" |
Стиль модуля. |
disabled |
false |
Disables the golang module. |
Пример
# ~/.config/starship.toml
[golang]
symbol = "🏎💨 "
Haskell
The haskell module shows the currently installed version of Haskell Stack version. Модуль будет показан, если любое из следующих условий соблюдено:
- The current directory contains a
stack.yamlfile
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"λ " |
The symbol used before displaying the version of Haskell. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Disables the haskell module. |
Пример
# ~/.config/starship.toml
[haskell]
symbol = " "
Имя хоста
Модуль 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.ktsorbuild.sbtfile - The current directory contains a file with the
.java,.class,.gradleor.jarextension
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"☕ " |
The symbol used before displaying the version of Java. |
style |
"dimmed red" |
Стиль модуля. |
disabled |
false |
Disables the java module. |
Пример
# ~/.config/starship.toml
[java]
symbol = "🌟 "
Jobs
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 |
"✦" |
The symbol used before displaying the number of jobs. |
threshold |
1 |
Show number of jobs if exceeded. |
style |
"bold blue" |
Стиль модуля. |
disabled |
false |
Disables the jobs module. |
Пример
# ~/.config/starship.toml
[jobs]
symbol = "+ "
threshold = 4
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 Подсказка
По умолчанию этот модуль отключен. Чтобы включить его, установите disabled на false в файле конфигурации.
:::
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"☸ " |
The symbol used before displaying the Cluster info. |
style |
"bold blue" |
Стиль модуля. |
disabled |
true |
Disables the kubernetes module |
Пример
# ~/.config/starship.toml
[kubernetes]
symbol = "⛵ "
style = "dimmed green"
disabled = false
Line Break
The line_break module separates the prompt into two lines.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
disabled |
false |
Disables the line_break module, making the prompt a single line. |
Пример
# ~/.config/starship.toml
[line_break]
disabled = true
Memory Usage
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 Подсказка
По умолчанию этот модуль отключен. Чтобы включить его, установите disabled на false в файле конфигурации.
:::
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
show_percentage |
false |
Display memory usage as a percentage of the available memory. |
show_swap |
true |
Display swap usage if total swap is non-zero. |
threshold |
75 |
Hide the memory usage unless it exceeds this percentage. |
symbol |
"🐏 " |
The symbol used before displaying the memory usage. |
separator |
`" | "` |
style |
"bold dimmed white" |
Стиль модуля. |
disabled |
true |
Disables the memory_usage module. |
Пример
# ~/.config/starship.toml
[memory_usage]
disabled = false
show_percentage = true
show_swap = true
threshold = -1
symbol = " "
separator = "/"
style = "bold dimmed green"
Mercurial Branch
The hg_branch module shows the active branch of the repo in your current directory.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
" " |
The symbol used before the hg bookmark or branch name of the repo in your current directory. |
truncation_length |
2^63 - 1 |
Truncates the hg branch name to X graphemes |
truncation_symbol |
"…" |
The symbol used to indicate a branch name was truncated. |
style |
"bold purple" |
Стиль модуля. |
disabled |
true |
Disables the hg_branch module. |
Пример
# ~/.config/starship.toml
[hg_branch]
symbol = "🌱 "
truncation_length = 4
truncation_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. |
style |
"bold red" |
Стиль модуля. |
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"
NodeJS
Модуль nodejs показывает установленную версию NodeJS. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл
package.json - Текущий каталог содержит каталог
node_modules - Текущий каталог содержит файл с расширением
.js
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"⬢ " |
Символ, используемый перед отображением версии NodeJS. |
style |
"bold green" |
Стиль модуля. |
disabled |
false |
Отключает модуль nodejs. |
Пример
# ~/.config/starship.toml
[nodejs]
symbol = "🤖 "
Версия пакета
Модуль package отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. Модуль в настоящее время поддерживает npm, cargo, poetry, composer, и gradle пакеты.
- npm – Версия пакета
npmиз файлаpackage.jsonв текущем каталоге - cargo – Версия пакета
cargoиз файлаCargo.tomlв текущем каталоге - poetry – Версия пакета
poetryиз файлаpyproject.tomlв текущем каталоге - composer – Версия пакета
composerизcomposer.jsonв текущем каталоге - gradle – Версия пакета
gradleизвлечена изbuild.gradle
⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"📦 " |
Символ, используемый перед отображением версии пакета. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Отключает модуль package. |
Пример
# ~/.config/starship.toml
[package]
symbol = "🎁 "
PHP
Модуль php показывает установленную версию PHP. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл
composer.json - Текущий каталог содержит файл
.php
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🐘 " |
Символ, используемый перед отображением версии PHP. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Отключает модуль php. |
Пример
# ~/.config/starship.toml
[php]
symbol = "🔹 "
Python
Модуль python показывает установленную версию Python.
Если переменной pyenv_version_name установлено значение true, на экране появится версия pyenv.
Иначе на экране будет показан номер версии из python --version и будет отображено текущее виртуального окружения Python, если активировано.
Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл
.python-version - Текущий каталог содержит файл
requirements.txt - Текущий каталог содержит файл
pyproject.toml - Текущий каталог содержит файл с расширением
.py - Текущий каталог содержит файл
Pipfile - Текущий каталог содержит файл
tox.ini - Виртуальная среда в данный момент активирована
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🐍 " |
Символ перед отображением текущей версии Python. |
pyenv_version_name |
false |
Использовать pyenv для получения версии Python |
pyenv_prefix |
"pyenv " |
Префикс перед отображением версии pyenv (отображение по умолчанию pyenv MY_VERSION) |
style |
"bold yellow" |
Стиль модуля. |
disabled |
false |
Disables the python module. |
Пример
# ~/.config/starship.toml
[python]
symbol = "👾 "
pyenv_version_name = true
pyenv_prefix = "foo "
Ruby
Модуль ruby показывает установленную версию Ruby. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл
Gemfile - Текущий каталог содержит файл
.rb
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"💎 " |
Символ, используемый перед отображением версии Ruby. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Отключает модуль ruby. |
Пример
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
Rust
Модуль rust показывает установленную версию Rust. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит файл
Cargo.toml - Текущий каталог содержит файл с расширением
.rs
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🦀 " |
Символ, используемый перед отображением версии Rust. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Отключает модуль rust. |
Пример
# ~/.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
Модуль terraform показывает выбранную рабочую область и версию terraform. По умолчанию, версия terraform не показана, так как это медленно на текущих версиях terraform, при использовании большого количества плагинов. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий каталог содержит папку
.terraform - Текущий каталог содержит файл с расширением
.tf
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"💠 " |
Символ, используемый перед отображением рабочего пространства terraform. |
show_version |
false |
Показать версию terraform. Очень медленно на больших рабочих пространствах. |
style |
"bold 105" |
Стиль модуля. |
disabled |
false |
Отключает модуль terraform. |
Пример
# ~/.config/starship.toml
[terraform]
symbol = "🏎💨 "
Время
Модуль time показывает текущее локальное время. Значение конфигурации format используется пакетом chrono для контроля того, как отображается время. Ознакомьтесь с документацией chrono strftime, чтобы увидеть доступные параметры.
::: tip Подсказка
По умолчанию этот модуль отключен. Чтобы включить его, установите disabled на false в файле конфигурации.
:::
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
use_12hr |
false |
Включить 12-часовое форматирование |
format |
см. ниже | Строка формата chrono, используемая для форматирования времени. |
style |
"bold yellow" |
Стиль модуля времени |
utc_time_offset |
"local" |
Устанавливает смещение UTC. Диапазон -24 < x < 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. |
disabled |
true |
Отключает модуль time. |
Если use_12hr равно true, то format по умолчанию равно "%r". Иначе по умолчанию используется "%T". Установка format вручную переопределит параметр use_12hr.
Пример
# ~/.config/starship.toml
[time]
disabled = false
format = "🕙[ %T ]"
utc_time_offset = "-5"
Имя пользователя
Модуль username показывает имя активного пользователя. Модуль будет показан, если любое из следующих условий соблюдено:
- Текущий пользователь - root
- Текущий пользователь отличается от залогиненного
- Пользователь подключен к SSH-сессии
- Переменная
show_alwaysравна true
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
style_root |
"bold red" |
Стиль, используемый для пользователя root. |
style_user |
"bold yellow" |
Стиль, используемый для всех пользователей, кроме root. |
show_always |
false |
Всегда показывать модуль username. |
disabled |
false |
Отключает модуль username. |
Пример
# ~/.config/starship.toml
[username]
disabled = true