1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-05 12:57:50 +00:00
starship/docs/uk-UA/config
2023-09-02 08:31:36 +01:00
..
README.md New translations README.md (Ukrainian) 2023-09-02 08:31:36 +01:00

Налаштування

Щоб почати налаштування starship, створіть наступний файл: ~/.config/starship.toml.

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

Всі налаштування для starship виконуються в цьому TOML файлі:

# Отримання автозавершення вводу команд з config-schema.json
"$schema" = 'https://starship.rs/config-schema.json'

# Додавати порожні рядки між командними рядками
add_newline = true

# Заміняти символ '' в командному рядку на символ  '➜'
[character] # Назва модуля, який ми налаштовуємо  'character'
success_symbol = '[➜](bold green)' # Частина 'success_symbol' буде використовувати символ '➜' підсвічений значенням 'bold green'

# Вимкнути модуль package, повністю приховавши його в командному рядку
[package]
disabled = true

Розташування файлу налаштувань

Ви можете змінити типове розташування файлу налаштувань за допомогою змінної середовища STARSHIP_CONFIG:

export STARSHIP_CONFIG=~/example/non/default/path/starship.toml

Так само і в PowerShell (Windows), можна додати цей рядок до $PROFILE:

$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"

Або для Cmd (Windows), додайте рядок до вашого файлу starship.lua:

os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')

Ведення журналу

Стандартно starship виводить попередження та інформацію про помилки у файл ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log, де ключ сесії відповідає екземпляру вашого термінала. Це, однак, може бути змінено за допомогою змінної середовища STARSHIP_CACHE:

export STARSHIP_CACHE=~/.starship/cache

Так само і в PowerShell (Windows), можна додати цей рядок до $PROFILE:

$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"

Або для Cmd (Windows), додайте рядок до вашого файлу starship.lua:

os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')

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

Модуль: Компонент командного рядка, що надає інформацію на основі контексту з вашої ОС. Наприклад, модуль "nodejs" показує версію Node.js, яка встановлена на вашому компʼютері, якщо ваша поточна тека є проєктом Node.js.

Змінна: менші субкомпоненти, що містять інформацію, що надається модулем. Наприклад, змінна "version" в модулі "nodejs" містить поточну версію Node.js.

Згідно з правилами, більшість модулів мають префікс стандартного кольору термінала (наприклад, via в "nodejs") та порожнє місце як суфікс.

Рядки

В синтаксисі TOML текстові значення оголошуються за допомогою лапок ', ", ''', or """.

Наступні символи синтаксису Starship мають спеціальне призначення у форматуванні рядків і повинні бути екрановані, якщо ви хочете показувати їх як символи: $ [ ] ( ).

Символ Тип Примітки
' літерал менш екранований
" рядок більш екранований
''' багаторядковий літерал менш екранований
""" багаторядковий рядок більш екранований, нові рядки в оголошеннях можуть бути проігноровані

Наприклад:

# літерал
format = '☺\☻ '

# звичайний рядок
format = "☺\\☻ "

# екрановані службові символи Starship
format = '\[\$\] '

При використанні символів розриву рядків можна використовувати багаторядкові оголошення. Наприклад, якщо ви хочете вивести символ $ на новий рядок, такі значення для format є еквівалентними:

# для літералів
format = '''

\$'''

# для звичайних багаторядкових рядків
format = """

\\$"""

# для звичайних рядків
format = "\n\\$"

У звичайних рядках, символ нового рядка можна використовувати наступним чином, щоб уникнути його показу.

format = """
line1\
line1\
line1
line2\
line2\
line2
"""

Формат рядків

Формат рядків це формат, з яким модуль виводить всі змінні. У більшості модулів є запис з назвою format, який налаштовує формат виводу модуля. Можна використовувати текст, змінні та текстові групи у форматуванні рядків.

Змінна

Змінна починається з символу $, за яким йде назва змінної. Назва змінною може складатись лише з літер та цифр та символу _.

Наприклад:

  • '$version – це форматований рядок зі змінною з назвою version.
  • $git_branch$git_commit' – рядок з двома змінними git_branch і git_commit.
  • '$git_branch $git_commit' має дві змінні, розділені пробілом.

Текстова група

Текстова група складається з двох різних частин.

Перша частина, яка вкладена у квадратні дужки [] – це форматований рядок. Ви можете додати текст, змінні або навіть вкладені текстові групи.

В наступній частині, що вкладена в круглі дужки (), міститься опис стилю рядка. Ця частина використовується для стилізації першої частини.

Наприклад:

  • '[on](red bold)' – виведе рядок on жирним шрифтом підсвічений червоним.
  • '[⌘ $version](bold green)' – виведе символ разом з вмістом змінної version жирним шрифтом підсвіченим зеленим.
  • '[a [b](red) c](green)' – виведе a b c, де b – червона, а a та c – зелені.

Рядки стилів

Більшість модулів в starship дозволяють вам налаштовувати стилі їх виводу. Це робиться за допомогою запису (зазвичай style), який є рядком, що вказує на конфігурацію. Ось деякі приклади стилів поряд з тим, що вони роблять. За деталями щодо повного синтаксису зверніться до Довідника з розширеного налаштування.

  • 'fg:green bg:blue' – зелений текст на блакитному фоні
  • 'bg:blue fg:bright-green' – яскраво зелений текст на блакитному фоні
  • 'bold fg:27' – жирний текст з ANSI кольором 27
  • 'underline bg:#bf5700' – підкреслений текст на яскраво помаранчевому фоні
  • 'bold italic fg:purple' – жирний курсив пурпурового кольору
  • '' – явним чином вимикає всі стилі

Зверніть увагу, що те, як виглядатиме стиль, як буде залежати від вашого емулятора термінала. Наприклад, деякі емулятори терміналів будуть виділяти кольори замість показу жирного тексту, а також деякі кольорові теми використовують однакові значення для нормального і яскравого кольорів. Також, щоб отримати курсив, ваш термінал має містити його підтримку.

Умовне форматування

Рядок з умовним форматуванням, огорнутий в круглі дужки ( та ), не буде показуватись якщо змінні в середині не містять значень.

Наприклад:

  • '(@$region)' – не буде показуватись, якщо змінна region дорівнює None чи є порожнім рядком, в іншому випадку вона буде показана разом з @, за яким йде значення регіону.
  • '(якийсь текст)' ніколи не буде показуватись, через те, що немає змінних, загорнутих в дужки.
  • Коли $combined є посиланням для \[$a$b\], '($combined)' не показуватиме нічого, лише якщо $a і $b одночасно містять None. Це працює так само й для '(\[$a$b\] )'.

Негативний збіг

Багато модулів мають змінні detect_extensions, detect_files та detect_folders. Вони отримують перелік рядків для порівняння, чи в них є збіги, чи – немає. Символ для перевірки "негативного збігу" (негативний збіг – те що не має мати збігу з вказаним значенням) – '!' знак оклику, вказується на початку параметра, що перевіряється. Наявність будь-якого індикатора негативного збігу в теці призведе до того, що результат роботи модуля буде перевірятись на негативний збіг.

Розширення зіставляються як із символами після останньої крапки в назві файлу, так і з символами після першої крапки в назві файлу. Наприклад, foo.bar.tar.gz буде збігатись з bar.tar.gz і gz у змінній detect_extensions. Файли, назва яких починається з крапки, взагалі не вважаються такими, що мають розширення.

Щоб побачити, як це працює на практиці, ви можете шукати збіг для файлів TypeScript, але не для MPEG Transport Stream, таким чином:

detect_extensions = ['ts', '!video.ts', '!audio.ts']

Командний рядок

Це перелік параметрів налаштувань, що використовуються для всього командного рядка.

Параметри

Параметр Стандартно Опис
format link Налаштовує формат командного рядка.
right_format '' Див Увімкнути командний рядок праворуч
scan_timeout 30 Тайм-аут для сканування файлів (у мілісекундах).
command_timeout 500 Тайм-аут для команд, виконаних starship (у мілісекундах).
add_newline true Вставити порожній рядок між командними рядками в оболонці.
palette '' Встановлює кольорову палітру використовуючи palettes.
palettes {} Колекція кольорових палітр, для призначення кольорів до назв визначених користувачем. Зверніть увагу, що кольорові палітри не можуть посилатися на їх власні визначення кольору.

Приклад

# ~/.config/starship.toml

# Використовуємо власний формат
format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) '''

# Чекаємо 10 мілісекунд, поки starship перевірить файли в поточній теці.
scan_timeout = 10

# Не додавати порожній рядок на початку командного рядка
add_newline = false

# Встановлює власну кольорову палітру 'foo'
palette = 'foo'

# Визначає власні кольори
[palettes.foo]
# Перевизначає наявний колір
blue = '21'
# Визначає новий колір
mustard = '#af8700'

Стандартний формат командного рядка

Стандартне значення змінної format використовується для визначення вигляду командного рядка, якщо вона пуста або змінна format відсутня. Стандартне значення є таким, як зазначено нижче:

format = '$all'

# Which is equivalent to
format = """
$username\
$hostname\
$localip\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$fossil_branch\
$fossil_metrics\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$pijul_channel\
$docker_context\
$package\
$c\
$cmake\
$cobol\
$daml\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$fennel\
$golang\
$guix_shell\
$haskell\
$haxe\
$helm\
$java\
$julia\
$kotlin\
$gradle\
$lua\
$nim\
$nodejs\
$ocaml\
$opa\
$perl\
$php\
$pulumi\
$purescript\
$python\
$raku\
$rlang\
$red\
$ruby\
$rust\
$scala\
$solidity\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$buf\
$nix_shell\
$conda\
$meson\
$spack\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$os\
$container\
$shell\
$character"""

Якщо ви просто хочете розширити стандартний формат, можете використовувати $all; модулі, які ви явно додали до формату, не будуть подвоєні. Напр.

# Перемістити назву теки на другий рядок
format = '$all$directory$character'

AWS

Модуль aws показує поточний регіон AWS і профіль, а також час, що залишився до кінця сесії при використанні тимчасових облікових даних. Для виводу модуль використовує змінні AWS_REGION, AWS_DEFAULT_REGION і AWS_PROFILE та файли ~/.aws/config і ~/.aws/credentials, коли треба.

Модуль показуватиме профіль якщо облікові дані знаходяться в ~/.aws/credentials або коли credential_process, sso_start_url, чи sso_session визначені в ~/.aws/config. Крім того, достатньо буде визначити будь-яку змінну AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY або AWS_SESSION_TOKEN. Якщо для параметра force_display встановлено значення true, уся доступна інформація буде показуватись, навіть якщо не буде виявлено жодних облікових даних відповідно до наведених вище умов.

Під час використання aws-vault профіль зчитується зі змінної AWS_VAULT, а дата закінчення терміну дії облікових даних зчитується зі змінної AWS_SESSION_EXPIRATION.

Під час використання awsu профіль читається зі змінної AWSU_PROFILE.

Під час використання AWSume профіль зчитується зі змінної AWSUME_PROFILE, а дата закінчення терміну дії облікових даних зчитується зі змінної AWSUME_EXPIRATION.

Під час використання saml2aws інформація про закінчення терміну дії, отримана з ~/.aws/credentials, повертається до ключа x_security_token_expires.

Параметри

Параметр Стандартно Опис
format 'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)' Формат модуля.
symbol '☁️ ' Символ, який використовується під час показу перед поточним профілем AWS.
region_aliases {} Таблиця псевдонімів регіону для показу на додачу до назви AWS.
profile_aliases {} Таблиця псевдонімів профілю для показу на додачу до назви AWS.
style 'bold yellow' Стиль модуля.
expiration_symbol X Символ, який показується, коли закінчився термін дії тимчасових облікових даних.
disabled false Вимикає модуль AWS.
force_display false Якщо true, інформація показується, навіть якщо credentials, credential_process або sso_start_url не вказано.

Змінні

Змінна Приклад Опис
region ap-northeast-1 Поточний регіон AWS
profile astronauts Поточний профіль AWS
duration 2h27m20s Термін дії тимчасових облікових даних
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклади

Показати все

# ~/.config/starship.toml

[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'

Показати регіон

# ~/.config/starship.toml

[aws]
format = 'on [$symbol$region]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'

Показати профіль

# ~/.config/starship.toml

[aws]
format = 'on [$symbol$profile]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'

Azure

Модуль azure показує поточну підписку Azure. Інформація заснована на назві стандартної підписки або імені користувача, як визначено у файлі ~/.azure/azureProfile.json.

Параметри

Змінна Стандартно Опис
format 'on [$symbol($subscription)]($style) ' Формат для модуля Azure.
symbol '󰠅 ' Символ, який використовується.
style 'blue bold' Стиль, який використовується.
disabled true Вимикає модуль azure.
subscription_aliases {} Таблиця псевдонімів підписки для показу на додачу до назви підписки Azure.

Приклади

Показ назви підписки

# ~/.config/starship.toml

[azure]
disabled = false
format = 'on [$symbol($subscription)]($style) '
symbol = '󰠅 '
style = 'blue bold'

Показ імені користувача

# ~/.config/starship.toml

[azure]
disabled = false
format = "on [$symbol($username)]($style) "
symbol = "󰠅 "
style = "blue bold"

Показ псевдонімів підписки

# ~/.config/starship.toml

[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'

Battery

Модуль battery показує наскільки заряджена батарея пристрою і стан заряджання. Модуль показується лише тоді, коли заряд акумулятора пристрою нижче 10%.

Параметри

Параметр Стандартно Опис
full_symbol '󰁹 ' Символ, повного заряду батареї.
charging_symbol '󰂄 ' Символ процесу заряджання.
discharging_symbol '󰂃 ' Символ, коли батарея розряджається.
unknown_symbol '󰁽 ' Символ, коли стан батареї невідомий.
empty_symbol '󰂎 ' Символ повністю розрядженої батареї.
format '[$symbol$percentage]($style) ' Формат модуля.
display link Граничні значення і стиль модуля.
disabled false Вимикає модуль battery.

Приклад

# ~/.config/starship.toml

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

Показ модуля Battery

Параметр конфігурації display використовується для визначення, коли має показуватись індикатор заряду батареї (threshold), який символ використовуватиметься (symbol) і як він виглядає (style). Якщо параметр display не встановлено. Стандартне значення є таким, як зазначено нижче:

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

Типові значення для опції charging_symbol і discharging_symbol є відповідно типовими значеннями параметрів charging_symbol та discharging_symbol батареї.

Параметри

Параметр display є масивом з наступної таблиці.

Параметр Стандартно Опис
threshold 10 Верхня межа для параметра.
style 'red bold' Стиль, який використовується, якщо параметр використовується.
charging_symbol Необов'язковий символ, що показується якщо параметр display використовується, стандартно використовується параметр charging_symbol.
discharging_symbol Необов'язковий символ, що показується якщо параметр display використовується, стандартно використовується параметр discharging_symbol.

Приклад

[[battery.display]] # стиль 'bold red' та discharging_symbol, якщо заряд між 0% та 10%
threshold = 10
style = 'bold red'

[[battery.display]] # стиль 'bold yellow' та символ 💦, якщо заряд між 10% та 30%
threshold = 30
style = 'bold yellow'
discharging_symbol = '💦'

# якщо рівень заряду понад 30%, індикатор заряду не показується

Buf

Модуль buf показує поточну встановлену версію Buf. Типово, модуль показується, якщо всі наступні умови виконуються:

Параметри

Параметр Стандартно Опис
format 'with [$symbol($version )]($style)' Формат для модуля buf.
version_format 'v${raw}' Формат версії.
symbol '🐃 ' Символ, який знаходиться перед версією Buf.
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml'] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
style 'bold blue' Стиль модуля.
disabled false Вимкнути модуль elixir.

Змінні

Змінна Приклад Опис
version v1.0.0 Версія buf
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[buf]
symbol = '🦬 '

Bun

Модуль bun показує поточну встановлену версію рушія JavaScript  bun. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл bun.lockb
  • Поточна тека містить файл bunfig.toml

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🍞 ' Формат рядка, що представляє символ Bun.
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['bun.lockb', 'bunfig.toml'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold red' Стиль модуля.
disabled false Вимикає модуль bun.

Змінні

Змінна Приклад Опис
version v0.1.4 Версія bun
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[bun]
format = 'via [🍔 $version](bold green) '

C

Модуль c показує інформацію про ваш C компілятор. Стандартно модуль буде показаний, якщо поточна тека містить файли .c чи .h.

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version(-$name) )]($style)' Формат рядка модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol 'C ' Символ, який знаходиться перед інформацією про компілятор
detect_extensions ['c', 'h'] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
commands [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] Як виявити компілятор
style 'bold 149' Стиль модуля.
disabled false Вимикає модуль c.

Змінні

Змінна Приклад Опис
name clang Назва компілятора
version 13.0.0 Версія компілятора
symbol Віддзеркалює значення параметра symbol
style Віддзеркалює значення параметра style

NB версія не має стандартного формату.

Commands

Параметр commands отримує список команд для визначення версії та назви компілятора.

Кожна команда представлена списком з назви виконавчого файлу та аргументів, зазвичай ['myc', '--version']. Starship спробує виконати кожну команду, поки не отримає результат в STDOUT.

Якщо C-компілятор не підтримується цим модулем, ви можете зробити запит на GitHub.

Приклад

# ~/.config/starship.toml

[c]
format = 'via [$name $version]($style)'

Character

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

Символ підкаже вам, чи була остання команда успішною, чи ні. Це можна зробити двома способами:

  • зміною кольору (red/green)
  • зміною символу (/)

Стандартно відбувається зміна кольору. Якщо ви також хочете змінювати й символ, подивитися на цей приклад.

::: warning

vimcmd_symbol працює лише з cmd, fish та zsh. vimcmd_replace_one_symbol, vimcmd_replace_symbol, and vimcmd_visual_symbol працює лише з fish через проблемою визначення режиму роботи в zsh.

:::

Параметри

Параметр Стандартно Опис
format '$symbol ' Формат рядка, що знаходиться перед введенням тексту.
success_symbol '[](bold green)' Формат рядка, що знаходиться перед введенням тексту, якщо попередня команда була успішно виконана.
error_symbol '[](bold red)' Формат рядка, що знаходиться перед введенням тексту, якщо попередня команда не була успішно виконана.
vimcmd_symbol '[](bold green)' Формат рядка, що знаходиться перед введенням тексту, якщо оболонка перебуває у звичайному режимі vim.
vimcmd_replace_one_symbol '[](bold purple)' Формат рядка, що знаходиться перед введенням тексту, якщо оболонка перебуває у режимі vim replace_one.
vimcmd_replace_symbol '[](bold purple)' Формат рядка, що знаходиться перед введенням тексту, якщо оболонка перебуває у режимі заміни vim.
vimcmd_visual_symbol '[](bold yellow)' Формат рядка, що знаходиться перед введенням тексту, якщо оболонка перебуває у візуальному режимі vim.
disabled false Вимикає модуль character.

Змінні

Змінна Приклад Опис
symbol Віддзеркалює значення success_symbol, error_symbol, vimcmd_symbol або vimcmd_replace_one_symbol і подібне.

Приклади

З власним значком помилки

# ~/.config/starship.toml

[character]
success_symbol = '[➜](bold green) '
error_symbol = '[✗](bold red) '

Без власного значка помилки

# ~/.config/starship.toml

[character]
success_symbol = '[➜](bold green) '
error_symbol = '[➜](bold red) '

Значок vim

# ~/.config/starship.toml

[character]
vimcmd_symbol = '[V](bold green) '

CMake

Модуль cmake показує поточну встановлену версію CMake. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл CMakeLists.txt
  • Поточна тека містить файл CMakeCache.txt

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '△ ' Символ, який йде перед версією cmak.
detect_extensions [] Які розширення повинні запускати цей модуль
detect_files ['CMakeLists.txt', 'CMakeCache.txt'] Назви файлів, які активують модуль
detect_folders [] Назви тек, що активують модуль
style 'bold blue' Стиль модуля.
disabled false Вимикає модуль cmake.

Змінні

Змінна Приклад Опис
version v3.17.3 Версія cmake
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

COBOL / GNUCOBOL

Модуль cobol показує встановлену версію COBOL. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли .cob або .COB
  • Поточна тека містить файли .cbl або .CBL

Параметри

Параметр Стандартно Опис
symbol '⚙️ ' Символ, який знаходиться перед версією COBOL.
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
style 'bold blue' Стиль модуля.
detect_extensions ['cbl', 'cob', 'CBL', 'COB'] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
disabled false Вимикає модуль cobol.

Змінні

Змінна Приклад Опис
version v3.1.2.0 Версія cobol
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Command Duration  час виконання

Модуль cmd_duration показує, скільки часу виконувалась остання команда. Модуль буде показаний лише в тому випадку, якщо на виконання команди пішло понад дві секунди або більше, ніж значення змінної min_time, якщо воно задане.

::: warning Не вмикайте DEBUG trap в Bash

Якщо ви запускаєте Starship у bash, не вмикайте DEBUG trap після запуску eval $(starship init $0), або цей модуль **** не працюватиме.

:::

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

Параметри

Параметр Стандартно Опис
min_time 2_000 Найменший час виконання для показу (в мілісекундах).
show_milliseconds false Показувати мілісекунди на додачу для секунд.
format 'took [$duration]($style) ' Формат модуля.
style 'bold yellow' Стиль модуля.
disabled false Вимикає модуль cmd_duration.
show_notifications false Показувати сповіщення на робочому столі після закінчення команди.
min_time_to_notify 45_000 Найменший час виконання для сповіщення (в мілісекундах).
notification_timeout Тривалість показу сповіщення (у мілісекундах). Якщо не налаштовано, час очікування сповіщень визначатиметься демоном. Не всі демони сповіщень підтримують цю опцію.

Змінні

Змінна Приклад Опис
duration 16m40s Час, витрачений на виконання команди
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[cmd_duration]
min_time = 500
format = 'underwent [$duration](bold yellow)'

Conda

Модуль conda показує інформацію про поточне оточення Conda, якщо змінна $CONDA_DEFAULT_ENV встановлена.

::: tip

Це не призводить до придушення власного модифікатора командного рядка в conda. Можливо, вам доведеться виконати conda config --set changeps1 False.

:::

Параметри

Параметр Стандартно Опис
truncation_length 1 Кількість тек, на які повинен бути скорочений шлях середовища, якщо середовище було створено за допомогою conda create -p [path]. 0 – означає без скорочення. Також подивіться модуль directory.
symbol '🅒 ' Символ що передує назві оточення.
style 'bold green' Стиль модуля.
format 'via [$symbol$environment]($style) ' Формат модуля.
ignore_base true Ігнорувати середовище base.
disabled false Вимикає модуль conda.

Змінні

Змінна Приклад Опис
environment astronauts Поточне середовище conda
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[conda]
format = '[$symbol$environment](dimmed green) '

Container

Модуль container показує символ та назву контейнера, коли ви перебуваєте в ньому.

Параметри

Параметр Стандартно Опис
symbol '⬢' Символ, що показується під час перебування в контейнері
style 'bold red dimmed' Стиль модуля.
format '[$symbol \[$name\]]($style) ' Формат модуля.
disabled false Вимикає модуль container.

Змінні

Змінна Приклад Опис
name fedora-toolbox:35 Назва контейнера
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[container]
format = '[$symbol \[$name\]]($style) '

Crystal

Модуль crystal показує поточну встановлену версію Crystal. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл shard.yml
  • Поточна тека містить файл .cr

Параметри

Параметр Стандартно Опис
symbol '🔮 ' Символ, який знаходиться перед версією crystal.
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
style 'bold red' Стиль модуля.
detect_extensions ['cr'] Які розширення повинні запускати цей модуль.
detect_files ['shard.yml'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
disabled false Вимикає модуль crystal.

Змінні

Змінна Приклад Опис
version v0.32.1 Версія crystal
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[crystal]
format = 'via [✨ $version](bold blue) '

Daml

Модуль daml показує поточну версію SDK Daml, коли ви перебуваєте в кореневій теці проєкту Daml. sdk-version у файлі daml.yaml буде використовуватись, якщо значення не буде перевизначене змінною оточення DAML_SDK_VERSION. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл daml.yaml

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol 'Λ ' Формат рядка, що представляє символ Daml
style 'bold cyan' Стиль модуля.
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['daml.yaml'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
disabled false Вимикає модуль daml.

Змінні

Змінна Приклад Опис
version v2.2.0 Версія daml
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[daml]
format = 'via [D $version](bold bright-green) '

Dart

Модуль dart показує поточну встановлену версію Dart. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл .dart
  • Поточна тека містить файл .dart_tool
  • Поточна тека містить файли pubspec.yaml, pubspec.yml або pubspec.lock

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🎯 ' Формат рядка, що представляє символ Dart
detect_extensions ['dart'] Які розширення повинні запускати цей модуль.
detect_files ['pubspec.yaml', 'pubspec.yml', 'pubspec.lock'] Які імена файлів мають запускати цей модуль.
detect_folders ['.dart_tool'] В яких теках цей модуль має запускатись.
style 'bold blue' Стиль модуля.
disabled false Вимикає модуль dart.

Змінні

Змінна Приклад Опис
version v2.8.4 Версія dart
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[dart]
format = 'via [🔰 $version](bold red) '

Deno

Модуль deno показує поточну встановлену версію Deno. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли deno.json, deno.jsonc, mod.ts, mod.js, deps.ts чи deps.js

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🦕 ' Формат рядка, що представляє символ Deno
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'green bold' Стиль модуля.
disabled false Вимикає модуль deno.

Змінні

Змінна Приклад Опис
version v1.8.3 Версія deno
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

Приклад

# ~/.config/starship.toml

[deno]
format = 'via [🦕 $version](green bold) '

Directory

Модуль directory показує шлях до поточної теки, урізаючи його до трьох останніх батьківських тек. Шлях до теки також буде скорочений до кореня git-репозиторію, якому ви перебуваєте.

Якщо використовується параметр fish_style_pwd_dir_length, замість того, щоб приховувати скорочений шлях, ви побачите скорочену назву кожної теки в залежності від числа, яке ви вказали для цього параметра.

Наприклад, маємо ~/Dev/Nix/nixpkgs/pkgs де nixpkgs є коренем репозиторію, а параметр — 1. Ви побачите ~/D/N/nixpkgs/pkgs, тоді як до цього було nixpkgs/pkg.

Параметри

Параметр Стандартно Опис
truncation_length 3 Кількість батьківських тек, до яких слід скоротити шлях до поточної теку.
truncate_to_repo true Скорочувати чи ні шлях до кореня git-репозиторію, коли ви перебуваєте в ньому.
format '[$path]($style)[$read_only]($read_only_style) ' Формат модуля.
style 'bold cyan' Стиль модуля.
disabled false Вимикає модуль directory.
read_only '🔒' Символ, який вказує, що поточна тека доступна лише для читання.
read_only_style 'red' Стиль символу для елементів read only.
truncation_symbol '' Символ на початку урізаних шляхів. напр: '…/'
before_repo_root_style Стиль частини шляху, що передує кореню git-репозиторію. Стандартне значення дорівнює style.
repo_root_style Стиль кореня git-репозиторію. Стандартне значення дорівнює style.
repo_root_format '[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) ' Формат git-репозиторію, коли задані before_repo_root_style та repo_root_style.
home_symbol '~' Символ, що позначає домашню теку.
use_os_path_sep true Використовувати розділювач шляхів, що притаманній вашій OS, замість того, щоб завжди використовувати / (напр \ у Windows)
Цей модуль має декілька додаткових опцій, які контролюють показ шляхів до тек.
Додатковий параметр Стандартно Опис
substitutions Таблиця підстановок, які буде зроблена у шляху теки.
fish_style_pwd_dir_length 0 Кількість символів, які використовуються при застосуванні логіки шляху fish shell pwd.
use_logical_path true Якщо true показувати логічний шлях оболонки через PWD або --logical-path. Якщо false – показувати шлях фізичної файлової системи з розвʼязанням шляхів для символічних посилань.

substitutions дозволяє визначити довільні заміни літер рядків, що зустрічаються в шляху, наприклад, довга префікси мережа або теки розробки (в Java). Зауважте, що це відключить стиль fish у PWD.

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

fish_style_pwd_dir_length взаємодіє зі стандартними опціями скорочення, по-перше, що може бути дивним, якщо значення не нуль, замість цього будуть показуватись компоненти шляху, які звичайно скорочені, зі вказаною кількістю символів. Наприклад, шлях /built/this/on/on/rock/and/roll, який зазвичай показуватиметься як rock/and/roll, буде показаний як /b/t/c/o/rock/and/roll з fish_style_pwd_dir_length = 1 — шлях компонентів, які зазвичай вилучаються, показуються одним символом. Для fish_style_pwd_dir_length = 2 це буде /bu/th/ci/on/rock/and/roll.

Змінні

Змінна Приклад Опис
path 'D:/Projects' Поточний шлях до теки
style* 'black bold dimmed' Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Git-репозиторії мають додаткові змінні.

Розгляньмо шлях /path/to/home/git_repo/src/lib

Змінна Приклад Опис
before_root_path Шлях до кореневої теки git
repo_root 'git_repo' Назва кореневої теки git
path '/src/lib' Залишок шляху
style 'black bold dimmed' Віддзеркалює значення параметра style
repo_root_style 'underline white' Стиль кореневої теки git

Приклад

# ~/.config/starship.toml

[directory]
truncation_length = 8
truncation_symbol = '…/'

Docker Context

Модуль docker_context показує поточний Docker context якщо його не встановлено у default, або якщо DOCKER_MACHINE_NAME DOCKER_HOST або DOCKER_CONTEXT змінні середовища встановлені (оскільки вони призначені для перевизначення контексту).

Параметри

Параметр Стандартно Опис
format 'via [$symbol$context]($style) ' Формат модуля.
symbol '🐳 ' Символ, який знаходиться перед Docker context.
only_with_files true Показувати, лише коли є збіг
detect_extensions [] Які розширення мають запускати цей модуль (потрібно щоб в only_with_files було true).
detect_files ['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile'] Які імена файлів мають запускати цей модуль (потрібно щоб в only_with_files було true).
detect_folders [] Які теки мають запускати цей модуль (потрібно щоб в only_with_files було true).
style 'blue bold' Стиль модуля.
disabled false Вимикає модуль docker_context.

Змінні

Змінна Приклад Опис
context test_context Поточний docker context
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[docker_context]
format = 'via [🐋 $context](blue bold)'

Dotnet

Модуль dotnet показує відповідну версію .NET Core SDK для поточної теки. Якщо SDK закріплена в поточній теці, показується закріплена версія. В іншому випадку модуль покаже останню встановлену версію SDK.

Стандартно модуль буде показаний в командному рядку, коли один чи більше з наступних файлів є в теці:

  • global.json
  • project.json
  • Directory.Build.props
  • Directory.Build.targets
  • Packages.props
  • *.csproj
  • *.fsproj
  • *.xproj

Вам також знадобиться .NET Core SDK, встановлений для того, щоб використовувати його правильно.

Всередині, цей модуль використовує власний механізм для виявлення версій. Як правило, він удвічі швидший ніж запуск dotnet --version, але він може показувати некоректну версію, якщо ваш проєкт .NET має не звичайне розташування тек. Якщо точність важливіша за швидкість, ви можете вимкнути механізм встановивши heuristic = false в налаштуваннях модуля.

Модуль також показуватиме Target Framework Monamework (https://docs.microsoft. om/en-us/dotnet/standard/frameworks#supported-target-frameworks), коли у поточній теці є файл .csproj.

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )(🎯 $tfm )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '.NET ' Символ, який знаходиться перед версією dotnet.
heuristic true Використовувати швидший алгоритм визначення версії, щоб ваш starship залишався швидким.
detect_extensions ['csproj', 'fsproj', 'xproj'] Які розширення повинні запускати цей модуль.
detect_files ['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props'] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
style 'bold blue' Стиль модуля.
disabled false Вимикає модуль dotnet.

Змінні

Змінна Приклад Опис
version v3.1.201 Версія dotnet sdk
tfm netstandard2.0 Псевдонім Target Framework, на який націлено поточний проєкт
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

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

Elixir

Модуль elixir показує поточну встановлену версію Elixir та Erlang/OTP. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл mix.exs.

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version \(OTP $otp_version\) )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '💧 ' Символ, який знаходиться перед версією Elixir/Erlang.
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['mix.exs'] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
style 'bold purple' Стиль модуля.
disabled false Вимикає модуль elixir.

Змінні

Змінна Приклад Опис
version v1.10 Версія elixir
otp_version Версія otp elixir
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[elixir]
symbol = '🔮 '

Elm

Модуль elm показує поточну встановлену версію Elm. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл elm.json
  • Поточна тека містить файл elm-package.json
  • Поточна тека містить файл .elm-version
  • Поточна тека містить файл elm-stuff
  • The current directory contains .elm files

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🌳 ' Формат рядка, що представляє символ Elm.
detect_extensions ['elm'] Які розширення повинні запускати цей модуль.
detect_files ['elm.json', 'elm-package.json', '.elm-version'] Які імена файлів мають запускати цей модуль.
detect_folders ['elm-stuff'] Які теки мають запускати цей модуль.
style 'cyan bold' Стиль модуля.
disabled false Вимикає модуль elm.

Змінні

Змінна Приклад Опис
version v0.19.1 Версія elm
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[elm]
format = 'via [ $version](cyan bold) '

Environment Variable

Модуль env_var показує поточне значення обраних змінних середовища. Модуль показується, якщо виконується будь-яка з наступних умов:

  • Параметр variable відповідає наявній змінній середовища
  • Параметр variable не визначено, але є параметр default

::: tip

Порядок в якому модуль env_var показується може встановлюватись індивідуально додавання ${env_var.foo} в format верхнього рівня (через те, що використовуються крапки, потрібно використовувати ${...}). Типово, модуль env_var покаже усі модулі env_var, в тому порядку того, як вони були визначені.

:::

::: tip

Кілька змінних оточення можуть бути показані за допомоги .. (див. приклад) Якщо опції конфігурації variable не встановлено, модуль показуватиме значення змінної після символу . під назвою.

Приклад: наступна конфігурація показуватиме значення змінної середовища USER

# ~/.config/starship.toml

[env_var.USER]
default = 'unknown user'

:::

Параметри

Параметр Стандартно Опис
symbol "" Символ, який знаходиться перед значенням variable.
variable Змінна середовища для показу.
default Стандартне значення буде показане, якщо змінні для показу не визначені.
format "with [$env_value]($style) " Формат модуля.
description "<env_var module>" Опис модуля, який показується під час запуску starship explain.
disabled false Вимикає модуль env_var.

Змінні

Змінна Приклад Опис
env_value Windows NT (якщо variable буде $OS) Значення змінної оточення з параметра variable
symbol Віддзеркалює значення параметра symbol
style* black bold dimmed Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

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

Показ кількох змінних оточення:

# ~/.config/starship.toml

[env_var.SHELL]
variable = 'SHELL'
default = 'unknown shell'
[env_var.USER]
default = 'unknown user'

Erlang

Модуль erlang показує поточну встановлену версію Erlang/OTP. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл rebar.config.
  • Поточна тека містить файл erlang.mk.

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol ' ' Символ, який знаходиться перед версією erlang.
style 'bold red' Стиль модуля.
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['rebar.config', 'elang.mk'] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
disabled false Вимикає модуль erlang.

Змінні

Змінна Приклад Опис
version v22.1.3 Версія erlang
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[erlang]
format = 'via [e $version](bold red) '

Fennel

Модуль fennel показує поточну встановлену версію Fennel. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл .fnl

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🧅 ' Символ, який знаходиться перед версією fennel.
style 'bold green' Стиль модуля.
detect_extensions [fnl] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
disabled false Вимикає модуль fennel.

Змінні

Змінна Приклад Опис
version v1.2.1 Версія fennel
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[fennel]
symbol = '⫰ '

Fill

Модуль fill заповнює простір в рядку вказаним символом. Якщо використовується кілька модулів fill, вони можуть заповнювати рядок рівномірно розподіляючи його довжину між собою. Це корисно для форматування інших модулів.

Параметри

Параметр Стандартно Опис
symbol '.' Символ, який використовується для заповнення рядка.
style 'bold black' Стиль модуля.
disabled false Вимикає модуль fill

Приклад

# ~/.config/starship.toml
format = 'AA $fill BB $fill CC'

[fill]
symbol = '-'
style = 'bold green'

Створить рядок, що виглядатиме наступним чином:

AA -------------------------------------------- BB -------------------------------------------- CC

Fossil Branch

Модуль fossil_branch показує назву активної гілки у вашій поточній теці.

Параметри

Параметр Стандартно Опис
format 'on [$symbol$branch]($style) ' Формат модуля. Використовуйте '$branch для посилання на поточну гілку.
symbol ' ' Символ, що використовується перед назвою гілки у вашій поточній теці.
style 'bold purple' Стиль модуля.
truncation_length 2^63 - 1 Скорочує назву гілки Fossil до N графем
truncation_symbol '…' Символ, що використовується для позначення назви гілки, яка була скорочена. Ви можете використовувати '', щоб нічого не показувати.
disabled true Вимикає модуль fossil_branch.

Змінні

Змінна Приклад Опис
branch trunk Поточна гілка Fossil
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''

Fossil Metrics

The fossil_metrics module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.

Параметри

Параметр Стандартно Опис
format '([+$added]($added_style) )([-$deleted]($deleted_style) )' Формат модуля.
added_style 'bold green' The style for the added count.
deleted_style 'bold red' The style for the deleted count.
only_nonzero_diffs true Render status only for changed items.
disabled true Disables the fossil_metrics module.

Змінні

Змінна Приклад Опис
added 1 The current number of added lines
deleted 2 The current number of deleted lines
added_style* Mirrors the value of option added_style
deleted_style* Mirrors the value of option deleted_style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '

Google Cloud (gcloud)

The gcloud module shows the current configuration for gcloud CLI. This is based on the ~/.config/gcloud/active_config file and the ~/.config/gcloud/configurations/config_{CONFIG NAME} file and the CLOUDSDK_CONFIG env var.

When the module is enabled it will always be active, unless detect_env_vars has been set in which case the module will only be active be active when one of the environment variables has been set.

Параметри

Параметр Стандартно Опис
format 'on [$symbol$account(@$domain)(\($region\))]($style) ' Формат модуля.
symbol '☁️ ' The symbol used before displaying the current GCP profile.
region_aliases {} Table of region aliases to display in addition to the GCP name.
project_aliases {} Table of project aliases to display in addition to the GCP name.
detect_env_vars [] Which environmental variables should trigger this module
style 'bold blue' Стиль модуля.
disabled false Disables the gcloud module.

Змінні

Змінна Приклад Опис
region us-central1 The current GCP region
account foo The current GCP profile
domain example.com The current GCP profile domain
project The current GCP project
active default The active config name written in ~/.config/gcloud/active_config
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклади

Показувати обліковий запис та проєкт

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '

Показувати тільки назву активної конфігурації

# ~/.config/starship.toml

[gcloud]
format = '[$symbol$active]($style) '
style = 'bold yellow'

Показувати обліковий запис та псевдо регіону

# ~/.config/starship.toml

[gcloud]
symbol = '️🇬️ '
[gcloud.region_aliases]
us-central1 = 'uc1'
asia-northeast1 = 'an1'

Показувати обліковий запис та псевдо проєкту

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
[gcloud.project_aliases]
very-long-project-name = 'vlpn'

Git Branch

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

Параметри

Параметр Стандартно Опис
always_show_remote false Shows the remote tracking branch name, even if it is equal to the local branch name.
format 'on [$symbol$branch(:$remote_branch)]($style) ' Формат модуля. Використовуйте '$branch для посилання на поточну гілку.
symbol ' ' A format string representing the symbol of git branch.
style 'bold purple' Стиль модуля.
truncation_length 2^63 - 1 Truncates a git branch to N graphemes.
truncation_symbol '…' Символ, що використовується для позначення назви гілки, яка була скорочена. Ви можете використовувати '', щоб нічого не показувати.
only_attached false Only show the branch name when not in a detached HEAD state.
ignore_branches [] A list of names to avoid displaying. Useful for 'master' or 'main'.
disabled false Disables the git_branch module.

Змінні

Змінна Приклад Опис
branch master The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD).
remote_name origin The remote name.
remote_branch master The name of the branch tracked on remote_name.
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[git_branch]
symbol = '🌱 '
truncation_length = 4
truncation_symbol = ''
ignore_branches = ['master', 'main']

Git Commit

The git_commit module shows the current commit hash and also the tag (if any) of the repo in your current directory.

Параметри

Параметр Стандартно Опис
commit_hash_length 7 The length of the displayed git commit hash.
format '[\($hash$tag\)]($style) ' Формат модуля.
style 'bold green' Стиль модуля.
only_detached true Only show git commit hash when in detached HEAD state
tag_disabled true Disables showing tag info in git_commit module.
tag_max_candidates 0 How many commits to consider for tag display. The default only allows exact matches.
tag_symbol ' 🏷 ' Tag symbol prefixing the info shown
disabled false Disables the git_commit module.

Змінні

Змінна Приклад Опис
hash b703eb3 The current git commit hash
tag v1.0.0 The tag name if showing tag info is enabled.
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = '🔖 '

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' A format string displayed when a rebase is in progress.
merge 'MERGING' A format string displayed when a merge is in progress.
revert 'REVERTING' A format string displayed when a revert is in progress.
cherry_pick 'CHERRY-PICKING' A format string displayed when a cherry-pick is in progress.
bisect 'BISECTING' A format string displayed when a bisect is in progress.
am 'AM' A format string displayed when an apply-mailbox (git am) is in progress.
am_or_rebase 'AM/REBASE' A format string displayed when an ambiguous apply-mailbox or rebase is in progress.
style 'bold yellow' Стиль модуля.
format '\([$state( $progress_current/$progress_total)]($style)\) ' Формат модуля.
disabled false Disables the git_state module.

Змінні

Змінна Приклад Опис
state REBASING The current state of the repo
progress_current 1 The current operation progress
progress_total 2 The total operation progress
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = '[🍒 PICKING](bold red)'

Git Metrics

The git_metrics module will show the number of added and deleted lines in the current git repository.

::: tip

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

:::

Параметри

Параметр Стандартно Опис
added_style 'bold green' The style for the added count.
deleted_style 'bold red' The style for the deleted count.
only_nonzero_diffs true Render status only for changed items.
format '([+$added]($added_style) )([-$deleted]($deleted_style) )' Формат модуля.
disabled true Disables the git_metrics module.
ignore_submodules false Ignore changes to submodules

Змінні

Змінна Приклад Опис
added 1 The current number of added lines
deleted 2 The current number of deleted lines
added_style* Mirrors the value of option added_style
deleted_style* Mirrors the value of option deleted_style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[git_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '

Git Status

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

::: tip

The Git Status module is very slow in Windows directories (for example under /mnt/c/) when in a WSL environment. You can disable the module or use the windows_starship option to use a Windows-native Starship executable to compute git_status for those paths.

:::

Параметри

Параметр Стандартно Опис
format '([\[$all_status$ahead_behind\]]($style) )' The default format for git_status
conflicted '=' This branch has merge conflicts.
ahead '⇡' The format of ahead
behind '⇣' The format of behind
diverged '⇕' The format of diverged
up_to_date '' The format of up_to_date
untracked '?' The format of untracked
stashed '$' The format of stashed
modified '!' The format of modified
staged '+' The format of staged
renamed '»' The format of renamed
deleted '✘' The format of deleted
typechanged "" The format of typechange
style 'bold red' Стиль модуля.
ignore_submodules false Ignore changes to submodules.
disabled false Disables the git_status module.
windows_starship Use this (Linux) path to a Windows Starship executable to render git_status when on Windows paths in WSL.

Змінні

The following variables can be used in format:

Змінна Опис
all_status Shortcut for$conflicted$stashed$deleted$renamed$modified$staged$untracked
ahead_behind Displays diverged, ahead, behind or up_to_date format string based on the current status of the repo.
conflicted Displays conflicted when this branch has merge conflicts.
untracked Displays untracked when there are untracked files in the working directory.
stashed Displays stashed when a stash exists for the local repository.
modified Displays modified when there are file modifications in the working directory.
staged Displays staged when a new file has been added to the staging area.
renamed Displays renamed when a renamed file has been added to the staging area.
deleted Displays deleted when a file's deletion has been added to the staging area.
typechanged Displays typechange when a file's type has been changed in the staging area.
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

The following variables can be used in diverged:

Змінна Опис
ahead_count Number of commits ahead of the tracking branch
behind_count Number of commits behind the tracking branch

The following variables can be used in conflicted, ahead, behind, untracked, stashed, modified, staged, renamed and deleted:

Змінна Опис
count Show the number of files

Приклад

# ~/.config/starship.toml

[git_status]
conflicted = '🏳'
ahead = '🏎💨'
behind = '😰'
diverged = '😵'
up_to_date = '✓'
untracked = '🤷'
stashed = '📦'
modified = '📝'
staged = '[++\($count\)](green)'
renamed = '👅'
deleted = '🗑'

Show ahead/behind count of the branch being tracked

# ~/.config/starship.toml

[git_status]
ahead = '⇡${count}'
diverged = '⇕⇡${ahead_count}⇣${behind_count}'
behind = '⇣${count}'

Use Windows Starship executable on Windows paths in WSL

# ~/.config/starship.toml

[git_status]
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'

Go

The golang module shows the currently installed version of Go. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл go.mod
  • Поточна тека містить файл go.sum
  • Поточна тека містить файл go.work
  • Поточна тека містить файл glide.yaml
  • Поточна тека містить файл Gopkg.yml
  • Поточна тека містить файл Gopkg.lock
  • Поточна тека містить файл .go-version
  • Поточна тека містить теку Godeps
  • Поточна тека містить файл .go

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🐹 ' A format string representing the symbol of Go.
detect_extensions ['go'] Які розширення повинні запускати цей модуль.
detect_files ['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version'] Які імена файлів мають запускати цей модуль.
detect_folders ['Godeps'] В яких теках цей модуль має запускатись.
style 'bold cyan' Стиль модуля.
not_capable_style 'bold red' The style for the module when the go directive in the go.mod file does not match the installed Go version.
disabled false Disables the golang module.

Змінні

Змінна Приклад Опис
version v1.12.1 The version of go
mod_version 1.16 go version requirement as set in the go directive of go.mod. Will only show if the version requirement does not match the go version.
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[golang]
format = 'via [🏎💨 $version](bold cyan) '

Using mod_version

# ~/.config/starship.toml

[golang]
format = 'via [$symbol($version )($mod_version )]($style)'

Guix-shell

The guix_shell module shows the guix-shell environment. The module will be shown when inside a guix-shell environment.

Параметри

Параметр Стандартно Опис
format 'via [$symbol]($style) ' Формат модуля.
symbol "🐃 " A format string representing the symbol of guix-shell.
style "yellow bold" Стиль модуля.
disabled false Disables the guix_shell module.

Змінні

Змінна Приклад Опис
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[guix_shell]
disabled = true
format = 'via [🐂](yellow bold) '

Gradle

The gradle module shows the version of the Gradle Wrapper currently used in the project directory.

Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить теку gradle/wrapper/gradle-wrapper.properties.
  • Поточна тека містить файли .gradle або .gradle.kts.

The gradle module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.

Параметри

Параметр Стандартно Опис
format "via [$symbol($version )]($style)" Формат модуля.
version_format "v${raw}" Формат версії. Доступні змінні raw, major, minor та patch
symbol "🅶 " A format string representing the symbol of Gradle.
detect_extensions ["gradle", "gradle.kts"] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders ["gradle"] В яких теках цей модуль має запускатись.
style "bold bright-cyan" Стиль модуля.
disabled false Disables the gradle module.
recursive false Enables recursive finding for the gradle directory.

Змінні

Змінна Приклад Опис
version v7.5.1 The version of gradle
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Haskell

The haskell module finds the current selected GHC version and/or the selected Stack snapshot.

Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл stack.yaml
  • Поточна тека містить файли .hs, .cabal або .hs-boot

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
symbol 'λ ' A format string representing the symbol of Haskell
detect_extensions ['hs', 'cabal', 'hs-boot'] Які розширення повинні запускати цей модуль.
detect_files ['stack.yaml', 'cabal.project'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold purple' Стиль модуля.
disabled false Disables the haskell module.

Змінні

Змінна Приклад Опис
version ghc_version or snapshot depending on whether the current project is a Stack project
snapshot lts-18.12 Currently selected Stack snapshot
ghc_version 9.2.1 Currently installed GHC version
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Haxe

The haxe module shows the currently installed version of Haxe. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли project.xml, Project.xml, додаток. ml, haxelib.json, hxformat.json або .haxerc
  • Поточна тека містить теку .haxelib або haxe_libraries
  • Поточна тека містить файли .hx або .hxml

Параметри

Параметр Стандартно Опис
format "via [$symbol($version )]($style)" Формат модуля.
version_format "v${raw}" Формат версії. Доступні змінні raw, major, minor та patch
detect_extensions ["hx", "hxml"] Які розширення повинні запускати цей модуль.
detect_files ["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"] Які імена файлів мають запускати цей модуль.
detect_folders [".haxelib", "haxe_libraries"] Які теки мають запускати цей модуль.
symbol "⌘ " Формат рядка, що представляє символ Helm.
style "bold fg:202" Стиль модуля.
disabled false Disables the haxe module.

Змінні

Змінна Приклад Опис
version v4.2.5 The version of haxe
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[haxe]
format = "via [⌘ $version](bold fg:202) "

Helm

The helm module shows the currently installed version of Helm. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл helmfile.yaml
  • Поточна тека містить файл Chart.yaml

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['helmfile.yaml', 'Chart.yaml'] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
symbol '⎈ ' Формат рядка, що представляє символ Helm.
style 'bold white' Стиль модуля.
disabled false Disables the helm module.

Змінні

Змінна Приклад Опис
version v3.1.1 The version of helm
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[helm]
format = 'via [⎈ $version](bold white) '

Hostname

The hostname module shows the system hostname.

Параметри

Параметр Стандартно Опис
ssh_only true Only show hostname when connected to an SSH session.
ssh_symbol '🌐 ' A format string representing the symbol when connected to SSH session.
trim_at '.' String that the hostname is cut off at, after the first match. '.' will stop after the first dot. '' will disable any truncation
format '[$ssh_symbol$hostname]($style) in ' Формат модуля.
style 'bold dimmed green' Стиль модуля.
disabled false Disables the hostname module.

Змінні

Змінна Приклад Опис
hostname computer The hostname of the computer
style* Віддзеркалює значення параметра style
ssh_symbol '🌏 ' The symbol to represent when connected to SSH session

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[hostname]
ssh_only = false
format = '[$ssh_symbol](bold blue) on [$hostname](bold red) '
trim_at = '.companyname.com'
disabled = false

Java

The java module shows the currently installed version of Java. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • В поточній теці містяться файли pom.xml, build.gradle.kts, build.sbt, .java-version, deps.edn, project.clj, build.boot або .sdkmanrc
  • Поточна тека містить файли з розширеннями .java, .class, .gradle, .jar, .clj або .cljc

Параметри

Параметр Стандартно Опис
format 'via [${symbol}(${version} )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
detect_extensions ['java', 'class', 'gradle', 'jar', 'cljs', 'cljc'] Які розширення повинні запускати цей модуль.
detect_files ['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc'] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
symbol '☕ ' A format string representing the symbol of Java
style 'red dimmed' Стиль модуля.
disabled false Disables the java module.

Змінні

Змінна Приклад Опис
version v14 The version of java
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.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 are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.

The default functionality is:

  • 0 завдань -> нічого не показується.
  • 1 завдання -> показується symbol.
  • 2 чи більше завдань -> показується symbol + число.

::: warning

This module is not supported on tcsh and nu.

:::

::: warning

The threshold option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists. If threshold is set to 0, then the module will also show when there are 0 jobs running.

:::

Параметри

Параметр Стандартно Опис
threshold* 1 Show number of jobs if exceeded.
symbol_threshold 1 Show symbol if the job count is at least symbol_threshold.
number_threshold 2 Show the number of jobs if the job count is at least number_threshold.
format '[$symbol$number]($style) ' Формат модуля.
symbol '✦' The string used to represent the symbol variable.
style 'bold blue' Стиль модуля.
disabled false Disables the jobs module.

*: This option is deprecated, please use the number_threshold and symbol_threshold options instead.

Змінні

Змінна Приклад Опис
number 1 The number of jobs
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[jobs]
symbol = '+ '
number_threshold = 4
symbol_threshold = 0

Julia

The julia module shows the currently installed version of Julia. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл Project.toml
  • Поточна тека містить файл Manifest.toml
  • Поточна тека містить файл .jl

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
detect_extensions ['jl'] Які розширення повинні запускати цей модуль.
detect_files ['Project.toml', 'Manifest.toml'] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
symbol 'ஃ ' A format string representing the symbol of Julia.
style 'bold purple' Стиль модуля.
disabled false Disables the julia module.

Змінні

Змінна Приклад Опис
version v1.4.0 The version of julia
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[julia]
symbol = '∴ '

Kotlin

The kotlin module shows the currently installed version of Kotlin. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли, .kt або .kts

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
detect_extensions ['kt', 'kts'] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
symbol '🅺 ' A format string representing the symbol of Kotlin.
style 'bold blue' Стиль модуля.
kotlin_binary 'kotlin' Configures the kotlin binary that Starship executes when getting the version.
disabled false Disables the kotlin module.

Змінні

Змінна Приклад Опис
version v1.4.21 The version of kotlin
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[kotlin]
symbol = '🅺 '
# ~/.config/starship.toml

[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = 'kotlinc'

Kubernetes

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

::: tip

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

When the module is enabled it will always be active, unless any of detect_extensions, detect_files or detect_folders have been set in which case the module will only be active in directories that match those conditions.

:::

Параметри

::: warning

The context_aliases and user_aliases options are deprecated. Use contexts and the corresponding context_alias and user_alias options instead.

:::

Параметр Стандартно Опис
symbol '☸ ' A format string representing the symbol displayed before the Cluster.
format '[$symbol$context( \($namespace\))]($style) in ' Формат модуля.
style 'cyan bold' Стиль модуля.
context_aliases* {} Table of context aliases to display.
user_aliases* {} Table of user aliases to display.
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] Які теки мають запускати цей модуль.
contexts [] Customized styles and symbols for specific contexts.
disabled true Disables the kubernetes module.

*: This option is deprecated, please add contexts with the corresponding context_alias and user_alias options instead.

To customize the style of the module for specific environments, use the following configuration as part of the contexts list:

Змінна Опис
context_pattern Required Regular expression to match current Kubernetes context name.
user_pattern Regular expression to match current Kubernetes user name.
context_alias Context alias to display instead of the full context name.
user_alias User alias to display instead of the full user name.
style The style for the module when using this context. If not set, will use module's style.
symbol The symbol for the module when using this context. If not set, will use module's symbol.

Note that all regular expression are anchored with ^<pattern>$ and so must match the whole string. The *_pattern regular expressions may contain capture groups, which can be referenced in the corresponding alias via $name and $N (see example below and the rust Regex::replace() documentation).

Змінні

Змінна Приклад Опис
context starship-context The current kubernetes context name
namespace starship-namespace If set, the current kubernetes namespace
user starship-user If set, the current kubernetes user
cluster starship-cluster If set, the current kubernetes cluster
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false
contexts = [
  { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
]

Only show the module in directories that contain a k8s file.

# ~/.config/starship.toml

[kubernetes]
disabled = false
detect_files = ['k8s']

Kubernetes Context specific config

The contexts configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.

# ~/.config/starship.toml

[[kubernetes.contexts]]
# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
# equals "admin_user"
context_pattern = "production"
user_pattern = "admin_user"
style = "bold red"
context_alias = "prod"
user_alias = "admin"

[[kubernetes.contexts]]
# "green" style + a different symbol when Kubernetes current context name contains openshift
context_pattern = ".*openshift.*"
style = "green"
symbol = "💔 "
context_alias = "openshift"

[[kubernetes.contexts]]
# Using capture groups
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
context_alias = "gke-$cluster"

Line Break

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

Local IP

The localip module shows the IPv4 address of the primary network interface.

Параметри

Параметр Стандартно Опис
ssh_only true Only show IP address when connected to an SSH session.
format '[$localipv4]($style) ' Формат модуля.
style 'bold yellow' Стиль модуля.
disabled true Disables the localip module.

Змінні

Змінна Приклад Опис
localipv4 192.168.1.13 Contains the primary IPv4 address
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[localip]
ssh_only = false
format = '@[$localipv4](bold red) '
disabled = false

Lua

The lua module shows the currently installed version of Lua. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл .lua-version
  • Поточна тека містить теку lua
  • Поточна тека містить файли з розширенням .lua

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🌙 ' A format string representing the symbol of Lua.
detect_extensions ['lua'] Які розширення повинні запускати цей модуль.
detect_files ['.lua-version'] Які імена файлів мають запускати цей модуль.
detect_folders ['lua'] В яких теках цей модуль має запускатись.
style 'bold blue' Стиль модуля.
lua_binary 'lua' Configures the lua binary that Starship executes when getting the version.
disabled false Disables the lua module.

Змінні

Змінна Приклад Опис
version v5.4.0 The version of lua
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[lua]
format = 'via [🌕 $version](bold blue) '

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.

:::

Параметри

Параметр Стандартно Опис
threshold 75 Hide the memory usage unless it exceeds this percentage.
format 'via $symbol [${ram}( | ${swap})]($style) ' Формат модуля.
symbol '🐏' The symbol used before displaying the memory usage.
style 'bold dimmed white' Стиль модуля.
disabled true Disables the memory_usage module.

Змінні

Змінна Приклад Опис
ram 31GiB/65GiB The usage/total RAM of the current system memory.
ram_pct 48% The percentage of the current system memory.
swap** 1GiB/4GiB The swap memory size of the current system swap memory file.
swap_pct** 77% The swap memory percentage of the current system swap memory file.
symbol 🐏 Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system

Приклад

# ~/.config/starship.toml

[memory_usage]
disabled = false
threshold = -1
symbol = ' '
style = 'bold dimmed green'

Meson

The meson module shows the current Meson developer environment status.

By default the Meson project name is displayed, if $MESON_DEVENV is set.

Параметри

Параметр Стандартно Опис
truncation_length 2^32 - 1 Truncates a project name to N graphemes.
truncation_symbol '…' The symbol used to indicate a project name was truncated. Ви можете використовувати '', щоб нічого не показувати.
format 'via [$symbol$project]($style) ' Формат модуля.
symbol '⬢ ' The symbol used before displaying the project name.
style 'blue bold' Стиль модуля.
disabled false Disables the meson module.

Змінні

Змінна Приклад Опис
project starship The current Meson project name
symbol 🐏 Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[meson]
disabled = false
truncation_symbol = '--'
symbol = ' '
style = 'bold dimmed green'

Mercurial Branch

The hg_branch module shows the active branch and topic 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.
style 'bold purple' Стиль модуля.
format 'on [$symbol$branch(:$topic)]($style) ' Формат модуля.
truncation_length 2^63 - 1 Truncates the hg branch / topic name to N graphemes
truncation_symbol '…' Символ, що використовується для позначення назви гілки, яка була скорочена.
disabled true Disables the hg_branch module.

Змінні

Змінна Приклад Опис
branch master The active mercurial branch
topic feature The active mercurial topic
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[hg_branch]
format = 'on [🌱 $branch](bold purple)'
truncation_length = 4
truncation_symbol = ''

Nim

The nim module shows the currently installed version of Nim. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл nim.cfg
  • Поточна тека містить файли з розширенням .nim
  • Поточна тека містить файли з розширенням .nims
  • Поточна тека містить файли з розширенням .nimble

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' The format for the module
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '👑 ' The symbol used before displaying the version of Nim.
detect_extensions ['nim', 'nims', 'nimble'] Які розширення повинні запускати цей модуль.
detect_files ['nim.cfg'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold yellow' Стиль модуля.
disabled false Disables the nim module.

Змінні

Змінна Приклад Опис
version v1.2.0 The version of nimc
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.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.

Параметри

Параметр Стандартно Опис
format 'via [$symbol$state( \($name\))]($style) ' Формат модуля.
symbol '❄️ ' A format string representing the symbol of nix-shell.
style 'bold blue' Стиль модуля.
impure_msg 'impure' A format string shown when the shell is impure.
pure_msg 'pure' A format string shown when the shell is pure.
unknown_msg '' A format string shown when it is unknown if the shell is pure/impure.
disabled false Disables the nix_shell module.
heuristic false Attempts to detect new nix shell-style shells with a heuristic.

Змінні

Змінна Приклад Опис
state pure The state of the nix-shell
name lorri The name of the nix-shell
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[nix_shell]
disabled = true
impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) '

Node.js

The nodejs module shows the currently installed version of Node.js. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл package.json
  • Поточна тека містить файл .node-version
  • Поточна тека містить файл .nvmrc
  • Поточна тека містить теку node_modules
  • Поточна тека містить файли з розширеннями .js, .mjs або .cjs
  • Поточна тека містить файли з розширеннями .ts, .mts чи .cts

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol ' ' A format string representing the symbol of Node.js.
detect_extensions ['js', 'mjs', 'cjs', 'ts', 'mts', 'cts'] Які розширення повинні запускати цей модуль.
detect_files ['package.json', '.node-version'] Які імена файлів мають запускати цей модуль.
detect_folders ['node_modules'] В яких теках цей модуль має запускатись.
style 'bold green' Стиль модуля.
disabled false Disables the nodejs module.
not_capable_style bold red The style for the module when an engines property in package.json does not match the Node.js version.

Змінні

Змінна Приклад Опис
version v13.12.0 The version of node
engines_version >=12.0.0 node version requirement as set in the engines property of package.json. Will only show if the version requirement does not match the node version.
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[nodejs]
format = 'via [🤖 $version](bold green) '

OCaml

The ocaml module shows the currently installed version of OCaml. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли з розширенням .opam або теку _opam
  • Поточна тека містить теку esy.lock
  • Поточна тека містить файли dune або dune-project
  • Поточна тека містить файли jbuild чи jbuild-ignore
  • Поточна тека містить файл .merlin
  • Поточна тека містить файли з розширеннями .ml, .mli, .re або .rei

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)' Формат рядка модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🐫 ' The symbol used before displaying the version of OCaml.
global_switch_indicator '' The format string used to represent global OPAM switch.
local_switch_indicator '*' The format string used to represent local OPAM switch.
detect_extensions ['opam', 'ml', 'mli', 're', 'rei'] Які розширення повинні запускати цей модуль.
detect_files ['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin'] Які імена файлів мають запускати цей модуль.
detect_folders ['_opam', 'esy.lock'] В яких теках цей модуль має запускатись.
style 'bold yellow' Стиль модуля.
disabled false Disables the ocaml module.

Змінні

Змінна Приклад Опис
version v4.10.0 The version of ocaml
switch_name my-project The active OPAM switch
switch_indicator Mirrors the value of indicator for currently active OPAM switch
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[ocaml]
format = 'via [🐪 $version]($style) '

Open Policy Agent

The opa module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a .rego file.

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🪖 ' A format string representing the symbol of OPA.
detect_extensions ['rego'] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold blue' Стиль модуля.
disabled false Disables the opa module.

Змінні

Змінна Приклад Опис
version v0.44.0 The version of opa
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[opa]
format = 'via [⛑️  $version](bold red) '

OpenStack

The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations. to fetch the current project in use.

Параметри

Параметр Стандартно Опис
format 'on [$symbol$cloud(\($project\))]($style) ' Формат модуля.
symbol '☁️ ' The symbol used before displaying the current OpenStack cloud.
style 'bold yellow' Стиль модуля.
disabled false Disables the openstack module.

Змінні

Змінна Приклад Опис
cloud corp The current OpenStack cloud
project dev The current OpenStack project
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[openstack]
format = 'on [$symbol$cloud(\($project\))]($style) '
style = 'bold yellow'
symbol = '☁️ '

OS

The os module shows the current operating system. OS information is detected via the os_info crate.

::: warning

The os_info crate used by this module is known to be inaccurate on some systems.

:::

::: tip

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

:::

Параметри

Параметр Стандартно Опис
format "[$symbol]($style)" Формат модуля.
style "bold white" Стиль модуля.
disabled true Disables the os module.
symbols A table that maps each operating system to its symbol.

symbols allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a feature request.

# This is the default symbols table.
[os.symbols]
Alpaquita = "🔔 "
Alpine = "🏔️ "
Amazon = "🙂 "
Android = "🤖 "
Arch = "🎗️ "
Artix = "🎗️ "
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🦅 "
Gentoo = "🗜️ "
HardenedBSD = "🛡️ "
Illumos = "🐦 "
Linux = "🐧 "
Mabox = "📦 "
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄️ "
OpenBSD = "🐡 "
OpenCloudOS = "☁️ "
openEuler = "🦉 "
openSUSE = "🦎 "
OracleLinux = "🦴 "
Pop = "🍭 "
Raspbian = "🍓 "
Redhat = "🎩 "
RedHatEnterprise = "🎩 "
Redox = "🧪 "
Solus = "⛵ "
SUSE = "🦎 "
Ubuntu = "🎯 "
Unknown = "❓ "
Windows = "🪟 "

Змінні

Змінна Приклад Опис
symbol 🎗️ The current operating system symbol from advanced option symbols
name Arch Linux The current operating system name
type Arch The current operating system type
codename The current operating system codename, if applicable
edition The current operating system edition, if applicable
version The current operating system version, if applicable
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[os]
format = "on [($name )]($style)"
style = "bold blue"
disabled = false

[os.symbols]
Windows = " "
Arch = "Arch is the best! "

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, nimble, cargo, poetry, python, composer, gradle, julia, mix, helm, shards, daml and dart packages.

  • npm — версія пакунка npm отримується з package.json з поточної теки
  • Cargo — версія пакунка cargo отримується з Cargo.toml з поточної теки
  • Nimble — версія пакунка nimble з файлу *.nimble з поточної теки, отримана командою nimble dump
  • Poetry — версія пакунка poetry отримується з pyproject.toml з поточної теки
  • Python — версія пакунка python отримана із PEP 621 сумісних файлів pyproject.toml чи setup.cfg у поточній теці
  • Composer — версія пакунка composer отримується з composer.json з поточної теки
  • Gradle — версія пакунка gradle отримується з build.gradle з поточної теки
  • Julia — версія пакунка отримується з Project.toml з поточної теки
  • Mix — версія пакунка mix отримується з mix.exs з поточної теки
  • Helm — версія чарту helm отримується з Chart.yaml з поточної теки
  • Maven — версія пакунка maven отримується з pom.xml з поточної теки
  • Meson — версія пакунка meson отримується з meson.build з поточної теки
  • Shards — версія пакунка shards отримується з shard.yml з поточної теки
  • V — версія пакунка vlang отримується з v.mod з поточної теки
  • SBT — версія пакунка sbt отримується з build.sbt з поточної теки
  • Daml — версія пакунка daml отримується з daml.yaml з поточної теки
  • Dart — версія пакунка dart отримується з pubspec.yaml з поточної теки

⚠️ Показується версія пакунка, сирці якого знаходяться у вашій поточній теці, а не у вашому менеджері пакунків.

Параметри

Параметр Стандартно Опис
format 'is [$symbol$version]($style) ' Формат модуля.
symbol '📦 ' The symbol used before displaying the version the package.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
style 'bold 208' Стиль модуля.
display_private false Enable displaying version for packages marked as private.
disabled false Disables the package module.

Змінні

Змінна Приклад Опис
version v1.0.0 The version of your package
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[package]
format = 'via [🎁 $version](208 bold) '

Perl

The perl module shows the currently installed version of Perl. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли Makefile.PL чи Build.PL
  • Поточна тека містить файли cpanfile або cpanfile.snapshot
  • Поточна тека містить файли, META.json або META.yml
  • Поточна тека містить файл .perl-version
  • Поточна тека містить файли .pl, .pm або .pod

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат рядка модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🐪 ' The symbol used before displaying the version of Perl
detect_extensions ['pl', 'pm', 'pod'] Які розширення повинні запускати цей модуль.
detect_files ['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold 149' Стиль модуля.
disabled false Disables the perl module.

Змінні

Змінна Приклад Опис
version v5.26.1 The version of perl
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

Приклад

# ~/.config/starship.toml

[perl]
format = 'via [🦪 $version]($style) '

PHP

The php module shows the currently installed version of PHP. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл composer.json
  • Поточна тека містить файл .php-version
  • Поточна тека містить файл .php

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🐘 ' The symbol used before displaying the version of PHP.
detect_extensions ['php'] Які розширення повинні запускати цей модуль.
detect_files ['composer.json', '.php-version'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style '147 bold' Стиль модуля.
disabled false Disables the php module.

Змінні

Змінна Приклад Опис
version v7.3.8 The version of php
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[php]
format = 'via [🔹 $version](147 bold) '

Pijul Channel

The pijul_channel module shows the active channel of the repo in your current directory.

Параметри

Параметр Стандартно Опис
symbol ' ' The symbol used before the pijul channel name of the repo in your current directory.
style 'bold purple' Стиль модуля.
format 'on [$symbol$channel]($style) ' Формат модуля.
truncation_length 2^63 - 1 Truncates the pijul channel name to N graphemes
truncation_symbol '…' Символ, що використовується для позначення назви гілки, яка була скорочена.
disabled true Disables the pijul module.

Pulumi

The pulumi module shows the current username, selected Pulumi Stack, and version.

::: tip

By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, follow the example shown below.

:::

Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • У поточній теці є або Pulumi.yaml або Pulumi.yml
  • Батьківська тека містить або Pulumi.yaml або Pulumi.yml, якщо для search_upwards не встановлено значення false

Параметри

Параметр Стандартно Опис
format 'via [$symbol($username@)$stack]($style) ' Формат рядка модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol ' ' A format string shown before the Pulumi stack.
style 'bold 5' Стиль модуля.
search_upwards true Enable discovery of pulumi config files in parent directories.
disabled false Disables the pulumi module.

Змінні

Змінна Приклад Опис
version v0.12.24 The version of pulumi
stack dev The current Pulumi stack
username alice The current Pulumi username
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

З версією Pulumi

# ~/.config/starship.toml

[pulumi]
format = '[🛥 ($version )$stack]($style) '

Без версії Pulumi

# ~/.config/starship.toml
[pulumi]
symbol = '🛥 '
format = '[$symbol$stack]($style) '

PureScript

The purescript module shows the currently installed version of PureScript version. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл spago.dhall
  • Поточна тека містить файли з розширенням .purs

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '<=> ' The symbol used before displaying the version of PureScript.
detect_extensions ['purs'] Які розширення повинні запускати цей модуль.
detect_files ['spago.dhall'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold white' Стиль модуля.
disabled false Disables the purescript module.

Змінні

Змінна Приклад Опис
version 0.13.5 The version of purescript
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[purescript]
format = 'via [$symbol$version](bold white)'

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.

Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл .python-version
  • Поточна тека містить файл Pipfile
  • Поточна тека містить файл __init__.py
  • Поточна тека містить файл pyproject.toml
  • Поточна тека містить файл requirements.txt
  • Поточна тека містить файл setup.py
  • Поточна тека містить файл tox.ini
  • Поточна тека містить файл .py.
  • Віртуальне середовище активовано

Параметри

Параметр Стандартно Опис
format 'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🐍 ' A format string representing the symbol of Python
style 'yellow bold' Стиль модуля.
pyenv_version_name false Use pyenv to get Python version
pyenv_prefix pyenv Prefix before pyenv version display, only used if pyenv is used
python_binary ['python', 'python3', 'python2'] Configures the python binaries that Starship should executes when getting the version.
detect_extensions ['py'] Які розширення повинні запускати цей модуль
detect_files ['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini'] Назви файлів, які активують модуль
detect_folders [] Назви тек, що активують модуль
disabled false Disables the python module.

::: tip

The python_binary variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.

The default values and order for python_binary was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python, no matter if it points to python3 or python2). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to 'python3' will hide any Python version 2, see example below.

:::

Змінні

Змінна Приклад Опис
version 'v3.8.1' The version of python
symbol '🐍 ' Віддзеркалює значення параметра symbol
style 'yellow bold' Віддзеркалює значення параметра style
pyenv_prefix 'pyenv ' Mirrors the value of option pyenv_prefix
virtualenv 'venv' The current virtualenv name

Приклад

# ~/.config/starship.toml

[python]
symbol = '👾 '
pyenv_version_name = true
# ~/.config/starship.toml

[python]
# Only use the `python3` binary to get the version.
python_binary = 'python3'
# ~/.config/starship.toml

[python]
# Don't trigger for files with the py extension
detect_extensions = []
# ~/.config/starship.toml

[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ['./venv/bin/python', 'python', 'python3', 'python2']

R

The rlang module shows the currently installed version of R. The module will be shown if any of the following conditions are met:

  • Поточна тека містить файли з розширенням .R.
  • Поточна тека містить файли з розширенням .Rd.
  • Поточна тека містить файли з розширенням .Rmd.
  • Поточна тека містить файли з розширенням .Rproj.
  • Поточна тека містить файли з розширенням .Rsx.
  • Поточна тека містить файл .Rprofile
  • Поточна тека містить файл .Rproj.user

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '📐' A format string representing the symbol of R.
style 'blue bold' Стиль модуля.
detect_extensions ['R', 'Rd', 'Rmd', 'Rproj', 'Rsx'] Які розширення повинні запускати цей модуль
detect_files ['.Rprofile'] Назви файлів, які активують модуль
detect_folders ['.Rproj.user'] Назви тек, що активують модуль
disabled false Disables the r module.

Змінні

Змінна Приклад Опис
version v4.0.5 The version of R
symbol Віддзеркалює значення параметра symbol
style 'blue bold' Віддзеркалює значення параметра style

Приклад

# ~/.config/starship.toml

[rlang]
format = 'with [📐 $version](blue bold) '

Raku

The raku module shows the currently installed version of Raku. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл META6.json
  • Поточна тека містить файли .p6, .pm6, .raku, .rakumod або .pod6

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version-$vm_version )]($style)' Формат рядка модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🦋 ' The symbol used before displaying the version of Raku
detect_extensions ['p6', 'pm6', 'pod6', 'raku', 'rakumod'] Які розширення повинні запускати цей модуль.
detect_files ['META6.json'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold 149' Стиль модуля.
disabled false Disables the raku module.

Змінні

Змінна Приклад Опис
version v6.d The version of raku
vm_version moar The version of VM raku is built on
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

Приклад

# ~/.config/starship.toml

[raku]
format = 'via [🦪 $version]($style) '

Red

By default the red module shows the currently installed version of Red. The module will be shown if any of the following conditions are met:

  • Поточна тека містить файли .red або .reds

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🔺 ' A format string representing the symbol of Red.
detect_extensions ['red'] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'red bold' Стиль модуля.
disabled false Disables the red module.

Змінні

Змінна Приклад Опис
version v2.5.1 The version of red
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[red]
symbol = '🔴 '

Ruby

By default the ruby module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:

  • Поточна тека містить файл Gemfile
  • Поточна тека містить файл .ruby-version
  • Поточна тека містить файл .rb
  • Встановлено змінні середовища RUBY_VERSION або RBENV_VERSION

Starship gets the current Ruby version by running ruby -v.

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '💎 ' A format string representing the symbol of Ruby.
detect_extensions ['rb'] Які розширення повинні запускати цей модуль.
detect_files ['Gemfile', '.ruby-version'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
detect_variables ['RUBY_VERSION', 'RBENV_VERSION'] Which environment variables should trigger this module.
style 'bold red' Стиль модуля.
disabled false Disables the ruby module.

Змінні

Змінна Приклад Опис
version v2.5.1 The version of ruby
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[ruby]
symbol = '🔺 '

Rust

By default the rust module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:

  • Поточна тека містить файл Cargo.toml
  • Поточна тека містить файли з розширенням .rs

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🦀 ' A format string representing the symbol of Rust
detect_extensions ['rs'] Які розширення повинні запускати цей модуль.
detect_files ['Cargo.toml'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold red' Стиль модуля.
disabled false Disables the rust module.

Змінні

Змінна Приклад Опис
version v1.43.0-nightly The version of rustc
numver 1.51.0 The numeric component of the rustc version
toolchain beta The toolchain version
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[rust]
format = 'via [⚙️ $version](red bold)'

Scala

The scala module shows the currently installed version of Scala. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли build.sbt, .scalaenv або .sbtenv
  • Поточна тека містить файли .scala або .sbt
  • В поточній теці є тека .metals

Параметри

Параметр Стандартно Опис
format 'via [${symbol}(${version} )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
detect_extensions ['sbt', 'scala'] Які розширення повинні запускати цей модуль.
detect_files ['.scalaenv', '.sbtenv', 'build.sbt'] Які імена файлів мають запускати цей модуль.
detect_folders ['.metals'] Які теки мають запускати цей модуль.
symbol '🆂 ' A format string representing the symbol of Scala.
style 'red dimmed' Стиль модуля.
disabled false Disables the scala module.

Змінні

Змінна Приклад Опис
version 2.13.5 The version of scala
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[scala]
symbol = '🌟 '

Shell

The shell module shows an indicator for currently used shell.

::: tip

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

:::

Параметри

Параметр Стандартно Опис
bash_indicator 'bsh' A format string used to represent bash.
fish_indicator 'fsh' A format string used to represent fish.
zsh_indicator 'zsh' A format string used to represent zsh.
powershell_indicator 'psh' A format string used to represent powershell.
ion_indicator 'ion' A format string used to represent ion.
elvish_indicator 'esh' A format string used to represent elvish.
tcsh_indicator 'tsh' A format string used to represent tcsh.
xonsh_indicator 'xsh' A format string used to represent xonsh.
cmd_indicator 'cmd' A format string used to represent cmd.
nu_indicator 'nu' A format string used to represent nu.
unknown_indicator '' The default value to be displayed when the shell is unknown.
format '[$indicator]($style) ' Формат модуля.
style 'white bold' Стиль модуля.
disabled true Disables the shell module.

Змінні

Змінна Стандартно Опис
indicator Mirrors the value of indicator for currently used shell.
style* Mirrors the value of option style.

*: Ця змінна може бути використана лише як частина стилю рядка

Приклади

# ~/.config/starship.toml

[shell]
fish_indicator = '󰈺 '
powershell_indicator = '_'
unknown_indicator = 'mystery shell'
style = 'cyan bold'
disabled = false

SHLVL

The shlvl module shows the current SHLVL ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.

Параметри

Параметр Стандартно Опис
threshold 2 Display threshold.
format '[$symbol$shlvl]($style) ' Формат модуля.
symbol '↕️ ' The symbol used to represent the SHLVL.
repeat false Causes symbol to be repeated by the current SHLVL amount.
repeat_offset 0 Decrements number of times symbol is repeated by the offset value
style 'bold yellow' Стиль модуля.
disabled true Disables the shlvl module.

Змінні

Змінна Приклад Опис
shlvl 3 The current value of SHLVL
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[shlvl]
disabled = false
format = '$shlvl level(s) down'
threshold = 3

Using repeat and repeat_offset along with character module, one can get prompt like where last character is colored appropriately for return status code and preceeding characters are provided by shlvl.

# ~/.config/starship.toml

[shlvl]
disabled = false
format = '[$symbol$shlvl]($style)'
repeat = true
symbol = ''
repeat_offset = 1
threshold = 0

Singularity

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

Параметри

Параметр Стандартно Опис
format '[$symbol\[$env\]]($style) ' Формат модуля.
symbol '' A format string displayed before the image name.
style 'bold dimmed blue' Стиль модуля.
disabled false Disables the singularity module.

Змінні

Змінна Приклад Опис
env centos.img The current Singularity image
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[singularity]
format = '[📦 \[$env\]]($style) '

Solidity

The solidity module shows the currently installed version of Solidity The module will be shown if any of the following conditions are met:

  • Поточна тека містить файл .sol

Параметри

Параметр Стандартно Опис
format "via [$symbol($version )]($style)" Формат модуля.
version_format "v${major}.${minor}.${patch}" Формат версії. Доступні змінні raw, major, minor та patch
symbol "S " A format string representing the symbol of Solidity
`compiler ["solc"] The default compiler for Solidity.
detect_extensions ["sol"] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style "bold blue" Стиль модуля.
disabled false Disables this module.

Змінні

Змінна Приклад Опис
version v0.8.1 The version of solidity
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"

Spack

The spack module shows the current Spack environment, if $SPACK_ENV is set.

Параметри

Параметр Стандартно Опис
truncation_length 1 The number of directories the environment path should be truncated to. 0 – означає без скорочення. Також подивіться модуль directory.
symbol '🅢 ' Символ що передує назві оточення.
style 'bold blue' Стиль модуля.
format 'via [$symbol$environment]($style) ' Формат модуля.
disabled false Disables the spack module.

Змінні

Змінна Приклад Опис
environment astronauts The current spack environment
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[spack]
format = '[$symbol$environment](dimmed blue) '

Status

The status module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not 0. The status code will cast to a signed 32-bit integer.

::: tip

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

:::

Параметри

Параметр Стандартно Опис
format '[$symbol$status]($style) ' The format of the module
symbol '❌' The symbol displayed on program error
success_symbol '' The symbol displayed on program success
not_executable_symbol '🚫' The symbol displayed when file isn't executable
not_found_symbol '🔍' The symbol displayed when the command can't be found
sigint_symbol '🧱' The symbol displayed on SIGINT (Ctrl + c)
signal_symbol '⚡' The symbol displayed on any signal
style 'bold red' Стиль модуля.
recognize_signal_code true Enable signal mapping from exit code
map_symbol false Enable symbols mapping from exit code
pipestatus false Enable pipestatus reporting
pipestatus_separator | The symbol used to separate pipestatus segments (supports formatting)
pipestatus_format '\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)' The format of the module when the command is a pipeline
pipestatus_segment_format When specified, replaces format when formatting pipestatus segments
disabled true Disables the status module.

Змінні

Змінна Приклад Опис
status 127 The exit code of the last command
hex_status 0x7F The exit code of the last command in hex
int 127 The exit code of the last command
common_meaning ERROR Meaning of the code if not a signal
signal_number 9 Signal number corresponding to the exit code, only if signalled
signal_name KILL Name of the signal corresponding to the exit code, only if signalled
maybe_int 7 Contains the exit code number when no meaning has been found
pipestatus Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[status]
style = 'bg:blue'
symbol = '🔴 '
success_symbol = '🟢 SUCCESS'
format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false

Sudo

The sudo module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.

::: tip

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

:::

Параметри

Параметр Стандартно Опис
format '[as $symbol]($style)' The format of the module
symbol '🧙 ' The symbol displayed when credentials are cached
style 'bold blue' Стиль модуля.
allow_windows false Since windows has no default sudo, default is disabled.
disabled true Disables the sudo module.

Змінні

Змінна Приклад Опис
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[sudo]
style = 'bold green'
symbol = '👩‍💻 '
disabled = false
# On windows
# $HOME\.starship\config.toml

[sudo]
allow_windows = true
disabled = false

Swift

By default the swift module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:

  • Поточна тека містить файл Package.swift
  • Поточна тека містить файли з розширенням .swift

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '🐦 ' A format string representing the symbol of Swift
detect_extensions ['swift'] Які розширення повинні запускати цей модуль.
detect_files ['Package.swift'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'bold 202' Стиль модуля.
disabled false Disables the swift module.

Змінні

Змінна Приклад Опис
version v5.2.4 The version of swift
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[swift]
format = 'via [🏎  $version](red bold)'

Terraform

The terraform module shows the currently selected Terraform workspace and version.

::: tip

By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below.

:::

Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл .terraform
  • Поточна тека містить файли з розширеннями.tf, .tfplan або .tfstate

Параметри

Параметр Стандартно Опис
format 'via [$symbol$workspace]($style) ' Формат рядка модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '💠' A format string shown before the terraform workspace.
detect_extensions ['tf', 'tfplan', 'tfstate'] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders ['.terraform'] В яких теках цей модуль має запускатись.
style 'bold 105' Стиль модуля.
disabled false Disables the terraform module.

Змінні

Змінна Приклад Опис
version v0.12.24 The version of terraform
workspace default The current Terraform workspace
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

За версією Terraform

# ~/.config/starship.toml

[terraform]
format = '[🏎💨 $version$workspace]($style) '

Без версії Terraform

# ~/.config/starship.toml

[terraform]
format = '[🏎💨 $workspace]($style) '

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.

:::

Параметри

Параметр Стандартно Опис
format 'at [$time]($style) ' Формат рядка модуля.
use_12hr false Enables 12 hour formatting
time_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 time_format defaults to '%r'. Otherwise, it defaults to '%T'. Manually setting time_format will override the use_12hr setting.

Змінні

Змінна Приклад Опис
time 13:08:10 The current time.
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = '%T'
utc_time_offset = '-5'
time_range = '10:00:00-14:00:00'

Username

The username module shows active user's username. The module will be shown if any of the following conditions are met:

  • Поточний користувач має права суперкористувача
  • Поточний користувач не є таким же, як той, який увійшов до системи
  • Користувач зараз підключений через SSH
  • Змінна show_always встановлена в true

::: tip

SSH connection is detected by checking environment variables SSH_CONNECTION, SSH_CLIENT, and SSH_TTY. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.

:::

Параметри

Параметр Стандартно Опис
style_root 'bold red' The style used when the user is root/admin.
style_user 'bold yellow' The style used for non-root users.
format '[$user]($style) in ' Формат модуля.
show_always false Always shows the username module.
disabled false Disables the username module.

Змінні

Змінна Приклад Опис
style 'red bold' Mirrors the value of option style_root when root is logged in and style_user otherwise.
user 'matchai' The currently logged-in user ID.

Приклад

# ~/.config/starship.toml

[username]
style_user = 'white bold'
style_root = 'black bold'
format = 'user: [$user]($style) '
disabled = false
show_always = true

Vagrant

The vagrant module shows the currently installed version of Vagrant. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файл Vagrantfile

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '⍱ ' A format string representing the symbol of Vagrant.
detect_extensions [] Які розширення повинні запускати цей модуль.
detect_files ['Vagrantfile'] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'cyan bold' Стиль модуля.
disabled false Disables the vagrant module.

Змінні

Змінна Приклад Опис
version Vagrant 2.2.10 The version of Vagrant
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[vagrant]
format = 'via [⍱ $version](bold white) '

V

The vlang module shows you your currently installed version of V. Типово, модуль показується, якщо виконується будь-яка з наступних умов:

  • Поточна тека містить файли з розширенням .v
  • Поточна тека містить файли v.mod, vpkg.json або .vpkg-lock.json

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol 'V ' A format string representing the symbol of V
detect_extensions ['v'] Які розширення повинні запускати цей модуль.
detect_files ['v.mod', 'vpkg.json', '.vpkg-lock.json' ] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.
style 'blue bold' Стиль модуля.
disabled false Disables the vlang module.

Змінні

Змінна Приклад Опис
version v0.2 The version of v
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

Приклад

# ~/.config/starship.toml
[vlang]
format = 'via [V $version](blue bold) '

VCSH

The vcsh module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.

Параметри

Параметр Стандартно Опис
symbol '' The symbol used before displaying the repository name.
style 'bold yellow' Стиль модуля.
format 'vcsh [$symbol$repo]($style) ' Формат модуля.
disabled false Disables the vcsh module.

Змінні

Змінна Приклад Опис
repo dotfiles if in a VCSH repo named dotfiles The active repository name
symbol Віддзеркалює значення параметра symbol
style* black bold dimmed Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.config/starship.toml

[vcsh]
format = '[🆅 $repo](bold blue) '

Zig

By default the zig module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:

  • Поточна тека містить файл .zig

Параметри

Параметр Стандартно Опис
format 'via [$symbol($version )]($style)' Формат модуля.
version_format 'v${raw}' Формат версії. Доступні змінні raw, major, minor та patch
symbol '↯ ' The symbol used before displaying the version of Zig.
style 'bold yellow' Стиль модуля.
disabled false Disables the zig module.
detect_extensions ['zig'] Які розширення повинні запускати цей модуль.
detect_files [] Які імена файлів мають запускати цей модуль.
detect_folders [] В яких теках цей модуль має запускатись.

Змінні

Змінна Приклад Опис
version v0.6.0 The version of zig
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Приклад

# ~/.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:

  • Поточна тека містить файл, ім'я якого є в detect_files
  • Поточна тека містить теки, ім'я яких вказано в detect_folders
  • Поточна тека містить файл, розширення якого є в detect_extensions
  • Команда when повертає 0
  • Поточна операційна система (std::env::consts::OS) збігається з полем os, якщо визначено.

::: tip

Multiple custom modules can be defined by using a ..

:::

::: tip

The order in which custom modules are shown can be individually set by including ${custom.foo} in the top level format (as it includes a dot, you need to use ${...}). By default, the custom module will simply show all custom modules in the order they were defined.

:::

::: tip

Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!

:::

::: warning Command output is printed unescaped to the prompt

Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. \h, but this module will not work in a fish or zsh shell.

Format strings can also contain shell specific prompt sequences, e.g. Bash, Zsh.

:::

Параметри

Параметр Стандартно Опис
command '' The command whose output should be printed. The command will be passed on stdin to the shell.
when false Either a boolean value (true or false, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a 0 status code.
require_repo false If true, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options.
shell See below
description '<custom module>' The description of the module that is shown when running starship explain.
detect_files [] The files that will be searched in the working directory for a match.
detect_folders [] The directories that will be searched in the working directory for a match.
detect_extensions [] The extensions that will be searched in the working directory for a match.
symbol '' The symbol used before displaying the command output.
style 'bold green' Стиль модуля.
format '[$symbol($output )]($style)' Формат модуля.
disabled false Disables this custom module.
os Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values.
use_stdin An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling.
ignore_timeout false Ignore global command_timeout setting and keep running external commands, no matter how long they take.

Змінні

Змінна Опис
output The output of shell command in shell
symbol Віддзеркалює значення параметра symbol
style* Віддзеркалює значення параметра style

*: Ця змінна може бути використана лише як частина стилю рядка

Власні команди shell

shell accepts a non-empty list of strings, where:

  • Перший рядок — це шлях до оболонки для виконання команди.
  • Наступні — інші аргументи, що передаються до оболонки.

If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows.

The command will be passed in on stdin.

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

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
detect_files = ['foo'] # can specify filters but wildcards are not supported
when = ''' test "$HOME" = "$PWD" '''
format = ' transcending [$output]($style)'

[custom.time]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command', '-']

[custom.time-as-arg]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command']
use_stdin = false