7c05412f46
|
||
|---|---|---|
| .. | ||
| README.md | ||
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
Терминология
Модуль: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "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 |
link | Настройка порядка появления модулей командной строки. |
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",
"golang",
"java",
"nodejs",
"php",
"python",
"ruby",
"rust",
"terraform",
"nix_shell",
"conda",
"memory_usage",
"aws",
"env_var",
"cmd_duration",
"line_break",
"jobs",
"battery",
"time",
"character",
]
AWS
Модуль aws показывает текущий регион и профиль AWS. Основано на AWS_REGION, AWS_DEFAULT_REGION, и AWS_PROFILE переменных окружения и файле~/.aws/config.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"☁️ " |
Символ перед отображением текущего профиля AWS. |
style |
"bold yellow" |
Стиль модуля. |
disabled |
false |
Отключение модуля AWS. |
displayed_items |
all |
Выбор элементов. Возможные значения [all, profile, region] |
Пример
# ~/.config/starship.toml
[aws]
style = "bold blue"
symbol = "🅰 "
displayed_items = "region"
Батарея
Модуль battery показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
full_symbol |
"•" |
Символ, отображаемый при полной батарее. |
charging_symbol |
"⇡" |
Символ, показываемый при зарядке аккумулятора. |
discharging_symbol |
"⇣" |
Символ, показываемый при разрядке аккумулятора. |
display |
link | Порог отображения и стиль для модуля. |
disabled |
false |
Отключает модуль battery. |
Также, есть опции для некоторых нетипичных состояний батареи.
| Переменная | Описание |
|---|---|
unknown_symbol |
The symbol shown when the battery state is unknown. |
empty_symbol |
The symbol shown when the battery state is empty. |
Note: Battery indicator will be hidden if the status is unknown or empty unless you specify the option in the config.
Пример
# ~/.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.
::: предупреждение Не подключайте ловушку 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 |
Кратчайшая длительность для показа времени. |
prefix |
took |
Префикс, отображаемый перед продолжительностью команды. |
style |
"bold yellow" |
Стиль модуля. |
disabled |
false |
Отключает модуль cmd_duration. |
Пример
# ~/.config/starship.toml
[cmd_duration]
min_time = 4
prefix = "underwent "
Конда
The conda module shows the current conda environment, if $CONDA_DEFAULT_ENV is set.
::: tip
This does not suppress conda's own prompt modifier, you may want to run conda config --set changeps1 False.
:::
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
truncation_length |
1 |
The number of directories the environment path should be truncated to, if the environment was created via conda create -p [path]. 0 means no truncation. Also see the directory module. |
symbol |
"C " |
The symbol used before the environment name. |
style |
"bold green" |
The style for the module. |
disabled |
false |
Disables the conda module. |
Пример
# ~/.config/starship.toml
[conda]
style = "dimmed green"
Каталог
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 |
Количество родительских папок, к которым должен быть усечен текущий каталог. |
truncate_to_repo |
true |
Следует или нет обрезать до корня репозитория git, в котором вы находитесь. |
prefix |
"in " |
Prefix to display immediately before the directory. |
style |
"bold cyan" |
The style for the module. |
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. |
Пример
# ~/.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 " |
Символ перед отображением текущей версии dotnet. |
heuristic |
true |
Использовать быстрое определение версии, для сохранения скорости. |
style |
"bold blue" |
Стиль модуля. |
disabled |
false |
Отключает модуль dotnet. |
Пример
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
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. | |
переменная |
The environment variable to be displayed. | |
по умолчанию |
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 active branch of the repo in your current directory.
::: tip
This module is disabled by default. To enable it, set disabled to false in your configuration file.
:::
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
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" |
Стиль модуля. |
disabled |
true |
Disables the git_commit module. |
Пример
# ~/.config/starship.toml
[git_commit]
disabled = false
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 |
link | 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 |
link | Show and style the number of untracked files. |
stashed |
"$" |
A stash exists for the local repository. |
modified |
"!" |
There are file modifications in the working directory. |
modified_count |
link | Show and style the number of modified files. |
staged |
"+" |
A new file has been added to the staging area. |
staged_count |
link | Show and style the number of files staged files. |
renamed |
"»" |
A renamed file has been added to the staging area. |
renamed_count |
link | Show and style the number of renamed files. |
deleted |
"✘" |
A file's deletion has been added to the staging area. |
deleted_count |
link | 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 Status Counts
| Переменная | По умолчанию | Описание |
|---|---|---|
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 module will be shown if any of the following conditions are met:
- 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 = "🏎💨 "
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 = ""
Hostname
The hostname module shows the system hostname.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
ssh_only |
true |
Only show hostname when connected to an SSH session. |
prefix |
"" |
Prefix to display immediately before the hostname. |
suffix |
"" |
Suffix to display immediately after the hostname. |
trim_at |
"." |
String that the hostname is cut off at, after the first match. "." will stop after the first dot. "" will disable any truncation |
style |
"bold dimmed green" |
Стиль модуля. |
disabled |
false |
Disables the hostname module. |
Пример
# ~/.config/starship.toml
[hostname]
ssh_only = false
prefix = "⟪"
suffix = "⟫"
trim_at = ".companyname.com"
disabled = false
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
This module is disabled by default. To enable it, set disabled to false in your configuration file.
:::
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"☸ " |
The symbol used before displaying the Cluster info. |
style |
"bold blue" |
Стиль модуля. |
disabled |
true |
Disables the kubernetes module |
Пример
# ~/.config/starship.toml
[kubernetes]
symbol = "⛵ "
style = "dim 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
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"
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
This module is disabled by default. To enable it, set disabled to false in your configuration file.
:::
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
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]
show_percentage = true
show_swap = true
threshold = -1
symbol = " "
separator = "/"
style = "bold dimmed green"
Java
The java module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
- The current directory contains a
pom.xml,build.gradleorbuild.sbtfile - The current directory contains a file with the
.java,.classor.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 = "🌟 "
NodeJS
The nodejs module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
- The current directory contains a
package.jsonfile - The current directory contains a
node_modulesdirectory - The current directory contains a file with the
.jsextension
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
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, and poetry packages.
- npm – The
npmpackage version is extracted from thepackage.jsonpresent in the current directory - cargo – The
cargopackage version is extracted from theCargo.tomlpresent in the current directory - poetry – The
poetrypackage version is extracted from thepyproject.tomlpresent in the current directory - composer – The
composerpackage version is extracted from thecomposer.jsonpresent in the current directory
⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"📦 " |
The symbol used before displaying the version the package. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Disables the package module. |
Пример
# ~/.config/starship.toml
[package]
symbol = "🎁 "
PHP
The php module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
- The current directory contains a
composer.jsonfile - The current directory contains a
.phpfile
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🐘 " |
The symbol used before displaying the version of PHP. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Disables the php module. |
Пример
# ~/.config/starship.toml
[php]
symbol = "🔹 "
Python
The python module shows the currently installed version of Python.
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 and show the current Python virtual environment if one is activated.
The module will be shown if any of the following conditions are met:
- The current directory contains a
.python-versionfile - The current directory contains a
requirements.txtfile - The current directory contains a
pyproject.tomlfile - The current directory contains a file with the
.pyextension - The current directory contains a
Pipfilefile - The current directory contains a
tox.inifile - 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) |
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 module will be shown if any of the following conditions are met:
- The current directory contains a
Gemfilefile - The current directory contains a
.rbfile
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
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 module will be shown if any of the following conditions are met:
- The current directory contains a
Cargo.tomlfile - The current directory contains a file with the
.rsextension
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"🦀 " |
The symbol used before displaying the version of Rust. |
style |
"bold red" |
Стиль модуля. |
disabled |
false |
Disables the rust module. |
Пример
# ~/.config/starship.toml
[rust]
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 module will be shown if any of the following conditions are met:
- The current directory contains a
.terraformfolder - Current directory contains a file with the
.tfextension
Опции
| Переменная | По умолчанию | Описание |
|---|---|---|
symbol |
"💠 " |
The symbol used before displaying the terraform workspace. |
show_version |
false |
Shows the terraform version. Very slow on large workspaces. |
style |
"bold 105" |
The style for the module. |
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 |
disabled |
true |
Disables the time module. |
utc_time_offset |
local |
Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
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
Username
The username module shows active user's username. The module will be shown if any of the following conditions are met:
- 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_alwaysis set to true
Options
| Variable | Default | Description |
|---|---|---|
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. |
Example
# ~/.config/starship.toml
[username]
disabled = true