2023-04-11 04:05:27 +00:00
# Налаштування
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Щоб почати налаштування starship, створіть наступний файл: `~/.config/starship.toml` .
2022-10-15 01:53:32 +00:00
```sh
mkdir -p ~/.config & & touch ~/.config/starship.toml
```
2023-04-11 04:05:27 +00:00
В с і налаштування для starship виконуються в цьому [TOML ](https://github.com/toml-lang/toml ) файлі:
2022-10-15 01:53:32 +00:00
```toml
2023-04-11 04:05:27 +00:00
# Отримання автозавершення вводу команд з config-schema.json
2022-10-15 01:53:32 +00:00
"$schema" = 'https://starship.rs/config-schema.json'
2023-04-11 04:05:27 +00:00
# Додавати порожні рядки між командними рядками
2022-10-15 01:53:32 +00:00
add_newline = true
2023-04-11 04:05:27 +00:00
# Заміняти символ '❯ ' в командному рядку на символ '➜'
[character] # Назва модуля, який ми налаштовуємо – 'character'
success_symbol = '[➜](bold green)' # Частина 'success_symbol' буде використовувати символ '➜' підсвічений значенням 'bold green'
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
# Вимкнути модуль package, повністю приховавши його в командному рядку
2022-10-15 01:53:32 +00:00
[package]
disabled = true
```
2023-04-11 04:05:27 +00:00
### Розташування файлу налаштувань
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
Ви можете змінити типове розташування файлу налаштувань за допомогою змінної середовища `STARSHIP_CONFIG` :
2022-10-15 01:53:32 +00:00
```sh
export STARSHIP_CONFIG=~/example/non/default/path/starship.toml
```
2023-04-11 04:05:27 +00:00
Так само і в PowerShell (Windows), можна додати цей рядок до `$PROFILE` :
2022-10-15 01:53:32 +00:00
```powershell
$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"
```
2023-04-11 04:05:27 +00:00
А б о для Cmd (Windows), додайте рядок до вашого файлу `starship.lua` :
2022-10-15 01:53:32 +00:00
```lua
os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')
```
2023-04-11 04:05:27 +00:00
### Ведення журналу
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Стандартно starship виводить попередження та інформацію про помилки у файл `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log` , де ключ сесії відповідає екземпляру вашого термінала. Це, однак, може бути змінено за допомогою змінної середовища `STARSHIP_CACHE` :
2022-10-15 01:53:32 +00:00
```sh
export STARSHIP_CACHE=~/.starship/cache
```
2023-04-11 04:05:27 +00:00
Так само і в PowerShell (Windows), можна додати цей рядок до `$PROFILE` :
2022-10-15 01:53:32 +00:00
```powershell
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
2023-04-11 04:05:27 +00:00
А б о для Cmd (Windows), додайте рядок до вашого файлу `starship.lua` :
2022-10-15 01:53:32 +00:00
```lua
os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
```
2023-04-11 04:05:27 +00:00
### Термінологія
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
**Модуль**: Компонент командного рядка, що надає інформацію на основі контексту з вашої О С . Наприклад, модуль "nodejs" показує версію Node.js, яка встановлена на вашому компʼютері, якщо ваша поточна тека є проєктом Node.js.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
**Змінна**: менші субкомпоненти, що містять інформацію, що надається модулем. Наприклад, змінна "version" в модулі "nodejs" містить поточну версію Node.js.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Згідно з правилами, більшість модулів мають префікс стандартного кольору термінала (наприклад, `via` в "nodejs") та порожнє місце як суфікс.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Рядки
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
В синтаксисі TOML [текстові значення ](https://toml.io/en/v1.0.0#string ) оголошуються за допомогою лапок `'` , `"` , `'''` , or `"""` .
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
Наступні символи синтаксису Starship мають спеціальне призначення у форматуванні рядків і повинні бути екрановані, якщо ви хочете показувати їх як символи: `$ [ ] ( )` .
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
| Символ | Тип | Примітки |
| ------ | ---------------------- | --------------------------------------------------------------------- |
| `'` | літерал | менш екранований |
| `"` | рядок | більш екранований |
| `'''` | багаторядковий літерал | менш екранований |
| `"""` | багаторядковий рядок | більш екранований, нові рядки в оголошеннях можуть бути проігноровані |
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
Наприклад:
2022-12-05 06:54:12 +00:00
```toml
2023-04-11 04:05:27 +00:00
# літерал
2022-12-05 06:54:12 +00:00
format = '☺\☻ '
2023-04-11 04:05:27 +00:00
# звичайний рядок
2022-12-05 06:54:12 +00:00
format = "☺\\☻ "
2023-04-11 04:05:27 +00:00
# екрановані службові символи Starship
2022-12-05 06:54:12 +00:00
format = '\[\$\] '
```
2023-04-11 04:05:27 +00:00
При використанні символів розриву рядків можна використовувати багаторядкові оголошення. Наприклад, якщо ви хочете вивести символ `$` на новий рядок, такі значення для `format` є еквівалентними:
2022-12-05 06:54:12 +00:00
```toml
2023-04-11 04:05:27 +00:00
# для літералів
2022-12-05 06:54:12 +00:00
format = '''
\$'''
2023-04-11 04:05:27 +00:00
# для звичайних багаторядкових рядків
2022-12-05 06:54:12 +00:00
format = """
\\$"""
2023-04-11 04:05:27 +00:00
# для звичайних рядків
2022-12-05 06:54:12 +00:00
format = "\n\\$"
```
2023-04-11 04:05:27 +00:00
У звичайних рядках, символ нового рядка можна використовувати наступним чином, щоб уникнути його показу.
2022-12-05 06:54:12 +00:00
```toml
format = """
line1\
line1\
line1
line2\
line2\
line2
"""
```
2023-04-11 04:05:27 +00:00
### Формат рядків
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Формат рядків це формат, з яким модуль виводить всі змінні. У більшості модулів є запис з назвою `format` , який налаштовує формат виводу модуля. Можна використовувати текст, змінні та текстові групи у форматуванні рядків.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
#### Змінна
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Змінна починається з символу `$` , за яким йде назва змінної. Назва змінною може складатись лише з літер та цифр та символу `_` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Наприклад:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- `'$version` – це форматований рядок зі змінною з назвою `version` .
- `$git_branch$git_commit'` – рядок з двома змінними `git_branch` і `git_commit` .
- `'$git_branch $git_commit'` має дві змінні, розділені пробілом.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
#### Текстова група
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Текстова група складається з двох різних частин.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Перша частина, яка вкладена у квадратні дужки `[]` – це [форматований рядок ](#format-strings ). Ви можете додати текст, змінні а б о навіть вкладені текстові групи.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
В наступній частині, що вкладена в круглі дужки `()` , міститься [опис стилю рядка ](#style-strings ). Ця частина використовується для стилізації першої частини.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Наприклад:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- `'[on](red bold)'` – виведе рядок `on` жирним шрифтом підсвічений червоним.
- `'[⌘ $version](bold green)'` – виведе символ `⌘` разом з вмістом змінної `version` жирним шрифтом підсвіченим зеленим.
- `'[a [b](red) c](green)'` – виведе `a b c` , де `b` – червона, а `a` та `c` – зелені.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
#### Рядки стилів
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Більшість модулів в starship дозволяють вам налаштовувати стилі їх виводу. Це робиться за допомогою запису (зазвичай `style` ), який є рядком, що вказує на конфігурацію. Ось деякі приклади стилів поряд з тим, що вони роблять. З а деталями щодо повного синтаксису зверніться до [Довідника з розширеного налаштування ](/advanced-config/ ).
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- `'fg:green bg:blue'` – зелений текст на блакитному фоні
- `'bg:blue fg:bright-green'` – яскраво зелений текст на блакитному фоні
- `'bold fg:27'` – жирний текст з [ANSI кольором ](https://i.stack.imgur.com/KTSQa.png ) 27
- `'underline bg:#bf5700'` – підкреслений текст на яскраво помаранчевому фоні
- `'bold italic fg:purple'` – жирний курсив пурпурового кольору
- `''` – явним чином вимикає всі стилі
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Зверніть увагу, що те, як виглядатиме стиль, як буде залежати від вашого емулятора термінала. Наприклад, деякі емулятори терміналів будуть виділяти кольори замість показу жирного тексту, а також деякі кольорові теми використовують однакові значення для нормального і яскравого кольорів. Також, щоб отримати курсив, ваш термінал має містити його підтримку.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
#### Умовне форматування
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Рядок з умовним форматуванням, огорнутий в круглі дужки `(` та `)` , не буде показуватись якщо змінні в середині не містять значень.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Наприклад:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- `'(@$region)'` – не буде показуватись, якщо змінна `region` дорівнює `None` чи є порожнім рядком, в іншому випадку вона буде показана разом з `@` , за яким йде значення регіону.
- `'(якийсь текст)'` ніколи не буде показуватись, через те, що немає змінних, загорнутих в дужки.
- Коли `$combined` є посиланням для `\[$a$b\]` , `'($combined)'` не показуватиме нічого, лише якщо `$a` і `$b` одночасно містять `None` . Це працює так само й для `'(\[$a$b\] )'` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Негативний збіг
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Багато модулів мають змінні `detect_extensions` , `detect_files` та `detect_folders` . Вони отримують перелік рядків для порівняння, чи в них є збіги, чи – немає. Символ для перевірки "негативного збігу" (негативний збіг – те що не має мати збігу з вказаним значенням) – '!' знак оклику, вказується на початку параметра, що перевіряється. Наявність _б у дь-яко г о _ індикатора негативного збігу в теці призведе до того, що результат роботи модуля буде перевірятись на негативний збіг.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Розширення зіставляються як із символами після останньої крапки в назві файлу, так і з символами після першої крапки в назві файлу. Наприклад, `foo.bar.tar.gz` буде збігатись з `bar.tar.gz` і `gz` у змінній `detect_extensions` . Файли, назва яких починається з крапки, взагалі не вважаються такими, що мають розширення.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Щоб побачити, як це працює на практиці, ви можете шукати збіг для файлів TypeScript, але не для MPEG Transport Stream, таким чином:
2022-10-15 01:53:32 +00:00
```toml
2022-12-05 06:54:12 +00:00
detect_extensions = ['ts', '!video.ts', '!audio.ts']
2022-10-15 01:53:32 +00:00
```
2023-04-11 04:05:27 +00:00
## Командний рядок
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Це перелік параметрів налаштувань, що використовуються для всього командного рядка.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Параметр | Стандартно | Опис |
| ----------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link ](#default-prompt-format ) | Налаштовує формат командного рядка. |
| `right_format` | `''` | Див [Увімкнути командний рядок праворуч ](/advanced-config/#enable-right-prompt ) |
| `scan_timeout` | `30` | Тайм-аут для сканування файлів (у мілісекундах). |
| `command_timeout` | `500` | Тайм-аут для команд, виконаних starship (у мілісекундах). |
| `add_newline` | `true` | Вставити порожній рядок між командними рядками в оболонці. |
| `palette` | `''` | Встановлює кольорову палітру використовуючи `palettes` . |
| `palettes` | `{}` | Колекція кольорових палітр, для призначення [кольорів ](/advanced-config/#style-strings ) до назв визначених користувачем. Зверніть увагу, що кольорові палітри не можуть посилатися на їх власні визначення кольору. |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
2023-04-11 04:05:27 +00:00
# Використовуємо власний формат
2022-12-05 06:54:12 +00:00
format = '''
2022-10-15 01:53:32 +00:00
[┌───────────────────> ](bold green )
[│ ](bold green )$directory$rust$package
2022-12-05 06:54:12 +00:00
[└─> ](bold green ) '''
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
# Чекаємо 10 мілісекунд, поки starship перевірить файли в поточній теці.
2022-10-15 01:53:32 +00:00
scan_timeout = 10
2023-04-11 04:05:27 +00:00
# Н е додавати порожній рядок на початку командного рядка
2022-10-15 01:53:32 +00:00
add_newline = false
2023-04-11 04:05:27 +00:00
# Встановлює власну кольорову палітру 'foo'
2022-12-05 06:54:12 +00:00
palette = 'foo'
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
# Визначає власні кольори
2022-10-15 01:53:32 +00:00
[palettes.foo]
2023-04-11 04:05:27 +00:00
# Перевизначає наявний колір
2022-12-05 06:54:12 +00:00
blue = '21'
2023-04-11 04:05:27 +00:00
# Визначає новий колір
2022-12-05 06:54:12 +00:00
mustard = '#af8700'
2022-10-15 01:53:32 +00:00
```
2023-04-11 04:05:27 +00:00
### Стандартний формат командного рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Стандартне значення змінної `format` використовується для визначення вигляду командного рядка, якщо вона пуста а б о змінна `format` відсутня. Стандартне значення є таким, як зазначено нижче:
2022-10-15 01:53:32 +00:00
```toml
2022-12-05 06:54:12 +00:00
format = '$all'
2022-10-15 01:53:32 +00:00
2023-09-02 07:31:36 +00:00
# Which is equivalent to
2022-10-15 01:53:32 +00:00
format = """
$username\
$hostname\
$localip\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
2023-01-31 16:14:38 +00:00
$fossil_branch\
2023-09-02 07:31:36 +00:00
$fossil_metrics\
2022-10-15 01:53:32 +00:00
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
2023-01-31 16:14:38 +00:00
$pijul_channel\
2022-10-15 01:53:32 +00:00
$docker_context\
$package\
$c\
$cmake\
$cobol\
$daml\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
2023-01-31 16:14:38 +00:00
$fennel\
2022-10-15 01:53:32 +00:00
$golang\
2022-12-05 06:54:12 +00:00
$guix_shell\
2022-10-15 01:53:32 +00:00
$haskell\
2022-12-05 06:54:12 +00:00
$haxe\
2022-10-15 01:53:32 +00:00
$helm\
$java\
$julia\
$kotlin\
2023-01-31 16:14:38 +00:00
$gradle\
2022-10-15 01:53:32 +00:00
$lua\
$nim\
$nodejs\
$ocaml\
2022-12-05 06:54:12 +00:00
$opa\
2022-10-15 01:53:32 +00:00
$perl\
$php\
$pulumi\
$purescript\
$python\
$raku\
$rlang\
$red\
$ruby\
$rust\
$scala\
2023-06-06 14:10:23 +00:00
$solidity\
2022-10-15 01:53:32 +00:00
$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\
2022-12-05 06:54:12 +00:00
$os\
2022-10-15 01:53:32 +00:00
$container\
$shell\
$character"""
```
2023-04-11 04:05:27 +00:00
Якщо ви просто хочете розширити стандартний формат, можете використовувати `$all` ; модулі, які ви явно додали до формату, не будуть подвоєні. Напр.
2022-10-15 01:53:32 +00:00
```toml
2023-04-11 04:05:27 +00:00
# Перемістити назву теки на другий рядок
2022-12-05 06:54:12 +00:00
format = '$all$directory$character'
2022-10-15 01:53:32 +00:00
```
## AWS
2023-04-11 04:05:27 +00:00
Модуль `aws` показує поточний регіон AWS і профіль, а також час, що залишився до кінця сесії при використанні тимчасових облікових даних. Для виводу модуль використовує змінні `AWS_REGION` , `AWS_DEFAULT_REGION` і `AWS_PROFILE` та файли `~/.aws/config` і `~/.aws/credentials` , коли треба.
2022-10-15 01:53:32 +00:00
2023-06-06 14:10:23 +00:00
Модуль показуватиме профіль якщо облікові дані знаходяться в `~/.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` , уся доступна інформація буде показуватись, навіть якщо не буде виявлено жодних облікових даних відповідно до наведених вище умов.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Під час використання [aws-vault ](https://github.com/99designs/aws-vault ) профіль зчитується зі змінної `AWS_VAULT` , а дата закінчення терміну дії облікових даних зчитується зі змінної `AWS_SESSION_EXPIRATION` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Під час використання [awsu ](https://github.com/kreuzwerker/awsu ) профіль читається зі змінної `AWSU_PROFILE` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Під час використання [AWSume ](https://awsu.me ) профіль зчитується зі змінної `AWSUME_PROFILE` , а дата закінчення терміну дії облікових даних зчитується зі змінної `AWSUME_EXPIRATION` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Під час використання [saml2aws ](https://github.com/Versent/saml2aws ) інформація про закінчення терміну дії, отримана з `~/.aws/credentials` , повертається до ключа `x_security_token_expires` .
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `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` не вказано. |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ---------------- | ---------------------------------------- |
| region | `ap-northeast-1` | Поточний регіон AWS |
| profile | `astronauts` | Поточний профіль AWS |
| duration | `2h27m20s` | Термін дії тимчасових облікових даних |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклади
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
#### Показати все
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[aws]
format = 'on [$symbol($profile )(\($region\) ) ]($style )'
2022-12-05 06:54:12 +00:00
style = 'bold blue'
symbol = '🅰 '
2022-10-15 01:53:32 +00:00
[aws.region_aliases]
2022-12-05 06:54:12 +00:00
ap-southeast-2 = 'au'
us-east-1 = 'va'
2022-10-15 01:53:32 +00:00
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'
```
2023-04-11 04:05:27 +00:00
#### Показати регіон
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[aws]
2022-12-05 06:54:12 +00:00
format = 'on [$symbol$region ]($style ) '
style = 'bold blue'
symbol = '🅰 '
2022-10-15 01:53:32 +00:00
[aws.region_aliases]
2022-12-05 06:54:12 +00:00
ap-southeast-2 = 'au'
us-east-1 = 'va'
2022-10-15 01:53:32 +00:00
```
2023-04-11 04:05:27 +00:00
#### Показати профіль
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[aws]
2022-12-05 06:54:12 +00:00
format = 'on [$symbol$profile ]($style ) '
style = 'bold blue'
symbol = '🅰 '
2022-10-15 01:53:32 +00:00
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'
```
## Azure
2023-04-11 04:05:27 +00:00
Модуль `azure` показує поточну підписку Azure. Інформація заснована на назві стандартної підписки а б о імені користувача, як визначено у файлі `~/.azure/azureProfile.json` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-06-06 14:10:23 +00:00
| Змінна | Стандартно | Опис |
| ---------------------- | ---------------------------------------- | -------------------------------------------------------------------------- |
| `format` | `'on [$symbol($subscription)]($style) '` | Формат для модуля Azure. |
| `symbol` | `' '` | Символ, який використовується. |
| `style` | `'blue bold'` | Стиль, який використовується. |
| `disabled` | `true` | Вимикає модуль `azure` . |
| `subscription_aliases` | `{}` | Таблиця псевдонімів підписки для показу на додачу до назви підписки Azure. |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклади
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
#### Показ назви підписки
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[azure]
disabled = false
2022-12-05 06:54:12 +00:00
format = 'on [$symbol($subscription) ]($style ) '
2023-06-06 14:10:23 +00:00
symbol = ' '
2022-12-05 06:54:12 +00:00
style = 'blue bold'
```
2023-04-11 04:05:27 +00:00
#### Показ імені користувача
2022-12-05 06:54:12 +00:00
```toml
# ~/.config/starship.toml
[azure]
disabled = false
format = "on [$symbol($username) ]($style ) "
2023-06-06 14:10:23 +00:00
symbol = " "
2022-10-15 01:53:32 +00:00
style = "blue bold"
```
2023-06-06 14:10:23 +00:00
#### Показ псевдонімів підписки
```toml
# ~/.config/starship.toml
[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'
```
2022-10-15 01:53:32 +00:00
## Battery
2023-04-11 04:05:27 +00:00
Модуль `battery` показує наскільки заряджена батарея пристрою і стан заряджання. Модуль показується лише тоді, коли заряд акумулятора пристрою нижче 10%.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Параметр | Стандартно | Опис |
| -------------------- | --------------------------------- | ------------------------------------ |
2023-06-06 14:10:23 +00:00
| `full_symbol` | `' '` | Символ, повного заряду батареї. |
| `charging_symbol` | `' '` | Символ процесу заряджання. |
| `discharging_symbol` | `' '` | Символ, коли батарея розряджається. |
| `unknown_symbol` | `' '` | Символ, коли стан батареї невідомий. |
| `empty_symbol` | `' '` | Символ повністю розрядженої батареї. |
2023-04-11 04:05:27 +00:00
| `format` | `'[$symbol$percentage]($style) '` | Формат модуля. |
| `display` | [link ](#battery-display ) | Граничні значення і стиль модуля. |
| `disabled` | `false` | Вимикає модуль `battery` . |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[battery]
2022-12-05 06:54:12 +00:00
full_symbol = '🔋 '
charging_symbol = '⚡️ '
discharging_symbol = '💀 '
2022-10-15 01:53:32 +00:00
```
2023-04-11 04:05:27 +00:00
### Показ модуля Battery
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Параметр конфігурації `display` використовується для визначення, коли має показуватись індикатор заряду батареї (threshold), який символ використовуватиметься (symbol) і як він виглядає (style). Якщо параметр `display` не встановлено. Стандартне значення є таким, як зазначено нижче:
2022-10-15 01:53:32 +00:00
```toml
[[battery.display]]
threshold = 10
2022-12-05 06:54:12 +00:00
style = 'bold red'
2022-10-15 01:53:32 +00:00
```
2023-04-11 04:05:27 +00:00
Типові значення для опції `charging_symbol` і `discharging_symbol` є відповідно типовими значеннями параметрів `charging_symbol` та `discharging_symbol` `батареї` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
#### Параметри
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Параметр `display` є масивом з наступної таблиці.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Параметр | Стандартно | Опис |
| -------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | Верхня межа для параметра. |
| `style` | `'red bold'` | Стиль, який використовується, якщо параметр використовується. |
| `charging_symbol` | | Необов'язковий символ, що показується якщо параметр display використовується, стандартно використовується параметр `charging_symbol` . |
| `discharging_symbol` | | Необов'язковий символ, що показується якщо параметр display використовується, стандартно використовується параметр `discharging_symbol` . |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
#### Приклад
2022-10-15 01:53:32 +00:00
```toml
2023-04-11 04:05:27 +00:00
[[battery.display]] # стиль 'bold red' та discharging_symbol, якщо заряд між 0% та 10%
2022-10-15 01:53:32 +00:00
threshold = 10
2022-12-05 06:54:12 +00:00
style = 'bold red'
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
[[battery.display]] # стиль 'bold yellow' та символ 💦, якщо заряд між 10% та 30%
2022-10-15 01:53:32 +00:00
threshold = 30
2022-12-05 06:54:12 +00:00
style = 'bold yellow'
discharging_symbol = '💦'
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
# якщо рівень заряду понад 30%, індикатор заряду не показується
2022-10-15 01:53:32 +00:00
```
## Buf
2023-04-11 04:05:27 +00:00
Модуль `buf` показує поточну встановлену версію [Buf ](https://buf.build ). Типово, модуль показується, якщо всі наступні умови виконуються:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Встановлено [`buf` ](https://github.com/bufbuild/buf ) CLI.
- Поточна тека містить файли налаштувань [`buf.yaml` ](https://docs.buf.build/configuration/v1/buf-yaml ), [`buf.gen.yaml` ](https://docs.buf.build/configuration/v1/buf-gen-yaml ), чи [`buf.work.yaml` ](https://docs.buf.build/configuration/v1/buf-work-yaml ).
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------------- | -------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
| `version` | `v1.0.0` | Версія `buf` |
| `symbol` | | Віддзеркалює значення параметра `symbol` |
| `style` * | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[buf]
2022-12-05 06:54:12 +00:00
symbol = '🦬 '
2022-10-15 01:53:32 +00:00
```
## Bun
2023-04-11 04:05:27 +00:00
Модуль `bun` показує поточну встановлену версію рушія JavaScript – [bun ](https://bun.sh ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `bun.lockb`
- Поточна тека містить файл `bunfig.toml`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v0.1.4` | Версія `bun` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[bun]
2022-12-05 06:54:12 +00:00
format = 'via [🍔 $version ](bold green ) '
2022-10-15 01:53:32 +00:00
```
## C
2023-04-12 18:43:40 +00:00
Модуль `c` показує інформацію про ваш C компілятор. Стандартно модуль буде показаний, якщо поточна тека містить файли `.c` чи `.h` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `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` . |
2023-04-11 04:05:27 +00:00
### Змінні
| Змінна | Приклад | Опис |
| ------- | ------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| name | clang | Назва компілятора |
| version | 13.0.0 | Версія компілятора |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
NB `версія` не має стандартного формату.
2022-10-15 01:53:32 +00:00
### Commands
2023-04-12 18:43:40 +00:00
Параметр `commands` отримує список команд для визначення версії та назви компілятора.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Кожна команда представлена списком з назви виконавчого файлу та аргументів, зазвичай `['myc', '--version']` . Starship спробує виконати кожну команду, поки не отримає результат в STDOUT.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Якщо C-компілятор не підтримується цим модулем, ви можете зробити [запит на GitHub ](https://github.com/starship/starship/ ).
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[c]
2022-12-05 06:54:12 +00:00
format = 'via [$name $version ]($style )'
2022-10-15 01:53:32 +00:00
```
## Character
2023-04-12 18:43:40 +00:00
Модуль `character` показує символ (зазвичай стрілку) поруч з текстом, який вводиться в терміналі.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Символ підкаже вам, чи була остання команда успішною, чи ні. Це можна зробити двома способами:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- зміною кольору (`red`/`green`)
- зміною символу (`❯ `/`✖`)
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Стандартно відбувається зміна кольору. Якщо ви також хочете змінювати й символ, подивитися на [цей приклад ](#with-custom-error-shape ).
2022-10-15 01:53:32 +00:00
::: warning
2023-04-12 18:43:40 +00:00
`vimcmd_symbol` працює лише з cmd, fish та zsh. `vimcmd_replace_one_symbol` , `vimcmd_replace_symbol` , and `vimcmd_visual_symbol` працює лише з fish через [проблемою визначення режиму роботи в zsh ](https://github.com/starship/starship/issues/625#issuecomment-732454148 ).
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| --------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Змінна | Приклад | Опис |
| ------ | ------- | ------------------------------------------------------------------------------------------------------------------ |
| symbol | | Віддзеркалює значення `success_symbol` , `error_symbol` , `vimcmd_symbol` а б о `vimcmd_replace_one_symbol` і подібне. |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклади
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
#### З власним значком помилки
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[character]
2022-12-05 06:54:12 +00:00
success_symbol = '[➜](bold green) '
error_symbol = '[✗](bold red) '
2022-10-15 01:53:32 +00:00
```
2023-04-12 18:43:40 +00:00
#### Без власного значка помилки
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[character]
2022-12-05 06:54:12 +00:00
success_symbol = '[➜](bold green) '
error_symbol = '[➜](bold red) '
2022-10-15 01:53:32 +00:00
```
2023-04-12 18:43:40 +00:00
#### Значок vim
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[character]
2023-04-11 04:05:27 +00:00
vimcmd_symbol = '[V](bold green) '
2022-10-15 01:53:32 +00:00
```
## CMake
2023-04-12 18:43:40 +00:00
Модуль `cmake` показує поточну встановлену версію [CMake ](https://cmake.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `CMakeLists.txt`
- Поточна тека містить файл `CMakeCache.txt`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v3.17.3` | Версія cmake |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
## COBOL / GNUCOBOL
2023-04-12 18:43:40 +00:00
Модуль `cobol` показує встановлену версію COBOL. Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли `.cob` а б о `.COB`
- Поточна тека містить файли `.cbl` а б о `.CBL`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ---------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v3.1.2.0` | Версія `cobol` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
## Command Duration – час виконання
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Модуль `cmd_duration` показує, скільки часу виконувалась остання команда. Модуль буде показаний лише в тому випадку, якщо на виконання команди пішло понад дві секунди а б о більше, ніж значення змінної `min_time` , якщо воно задане.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
::: warning Н е вмикайте DEBUG trap в Bash
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Якщо ви запускаєте Starship у `bash` , не вмикайте `DEBUG` trap після запуску `eval $(starship init $0)` , а б о цей модуль ** ** не працюватиме.
2022-10-15 01:53:32 +00:00
:::
2023-04-12 18:43:40 +00:00
Користувачі Bash, яким потрібна функція preexec, можуть використовувати [фреймворк bash_preexec від rcaloras ](https://github.com/rcaloras/bash-preexec ). Просто визначте масиви `preexec_function` і `precmd_functions` перед запуском `eval $(starship init $0)` , а потім продовжуй як зазвичай.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ---------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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` | | Тривалість показу сповіщення (у мілісекундах). Якщо не налаштовано, час очікування сповіщень визначатиметься демоном. Н е всі демони сповіщень підтримують цю опцію. |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
2022-12-05 06:54:12 +00:00
| --------- | -------- | --------------------------------------- |
2023-04-12 18:43:40 +00:00
| duration | `16m40s` | Час, витрачений на виконання команди |
2023-04-11 04:05:27 +00:00
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
2022-12-05 06:54:12 +00:00
format = 'underwent [$duration ](bold yellow )'
2022-10-15 01:53:32 +00:00
```
## Conda
2023-04-12 18:43:40 +00:00
Модуль `conda` показує інформацію про поточне оточення [Conda ](https://docs.conda.io/en/latest/ ), якщо змінна `$CONDA_DEFAULT_ENV` встановлена.
2022-10-15 01:53:32 +00:00
::: tip
2023-04-12 18:43:40 +00:00
Це не призводить до придушення власного модифікатора командного рядка в conda. Можливо, вам доведеться виконати `conda config --set changeps1 False` .
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | Кількість тек, на які повинен бути скорочений шлях середовища, якщо середовище було створено за допомогою `conda create -p [path]` . `0` – означає без скорочення. Також подивіться модуль [`directory` ](#directory ). |
| `symbol` | `'🅒 '` | Символ що передує назві оточення. |
| `style` | `'bold green'` | Стиль модуля. |
| `format` | `'via [$symbol$environment]($style) '` | Формат модуля. |
| `ignore_base` | `true` | Ігнорувати середовище `base` . |
| `disabled` | `false` | Вимикає модуль `conda` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| ----------- | ------------ | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| environment | `astronauts` | Поточне середовище conda |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[conda]
2022-12-05 06:54:12 +00:00
format = '[$symbol$environment](dimmed green) '
2022-10-15 01:53:32 +00:00
```
## Container
2023-04-12 18:43:40 +00:00
Модуль `container` показує символ та назву контейнера, коли ви перебуваєте в ньому.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `symbol` | `'⬢'` | Символ, що показується під час перебування в контейнері |
| `style` | `'bold red dimmed'` | Стиль модуля. |
| `format` | `'[$symbol \[$name\]]($style) '` | Формат модуля. |
| `disabled` | `false` | Вимикає модуль `container` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------------------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| name | `fedora-toolbox:35` | Назва контейнера |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[container]
format = '[$symbol \[$name\]]($style) '
```
## Crystal
2023-04-12 18:43:40 +00:00
Модуль `crystal` показує поточну встановлену версію [Crystal ](https://crystal-lang.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `shard.yml`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.cr`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v0.32.1` | Версія `crystal` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[crystal]
2022-12-05 06:54:12 +00:00
format = 'via [✨ $version ](bold blue ) '
2022-10-15 01:53:32 +00:00
```
## Daml
2023-04-12 18:43:40 +00:00
Модуль `daml` показує поточну версію SDK [Daml ](https://www.digitalasset.com/developers ), коли ви перебуваєте в кореневій теці проєкту Daml. `sdk-version` у файлі `daml.yaml` буде використовуватись, якщо значення не буде перевизначене змінною оточення `DAML_SDK_VERSION` . Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `daml.yaml`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v2.2.0` | Версія `daml` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[daml]
2022-12-05 06:54:12 +00:00
format = 'via [D $version ](bold bright-green ) '
2022-10-15 01:53:32 +00:00
```
## Dart
2023-04-12 18:43:40 +00:00
Модуль `dart` показує поточну встановлену версію [Dart ](https://dart.dev/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.dart`
- Поточна тека містить файл `.dart_tool`
- Поточна тека містить файли `pubspec.yaml` , `pubspec.yml` а б о `pubspec.lock`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------------------- | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v2.8.4` | Версія `dart` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[dart]
2022-12-05 06:54:12 +00:00
format = 'via [🔰 $version ](bold red ) '
2022-10-15 01:53:32 +00:00
```
## Deno
2023-04-12 18:43:40 +00:00
Модуль `deno` показує поточну встановлену версію [Deno ](https://deno.land/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли `deno.json` , `deno.jsonc` , `mod.ts` , `mod.js` , `deps.ts` чи `deps.js`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v1.8.3` | Версія `deno` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[deno]
2022-12-05 06:54:12 +00:00
format = 'via [🦕 $version ](green bold ) '
2022-10-15 01:53:32 +00:00
```
## Directory
2023-04-12 18:43:40 +00:00
Модуль `directory` показує шлях до поточної теки, урізаючи його до трьох останніх батьківських тек. Шлях до теки також буде скорочений до кореня git-репозиторію, якому ви перебуваєте.
2022-10-15 01:53:32 +00:00
docs(i18n): new Crowdin updates (#5237)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Russian)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Norwegian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Japanese)
* New translations README.md (Polish)
* New translations README.md (Spanish)
* New translations README.md (Japanese)
* New translations README.md (Polish)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Ukrainian)
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (French)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Vietnamese)
* New translations README.md (Vietnamese)
* New translations README.md (Vietnamese)
* New translations README.md (French)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (Polish)
* New translations README.md (Spanish)
* New translations README.md (French)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Russian)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Spanish)
* New translations README.md (French)
* New translations README.md (German)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Ukrainian)
* New translations README.md (Ukrainian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Spanish)
* New translations README.md (French)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Russian)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Ukrainian)
2023-07-30 13:29:01 +00:00
Якщо використовується параметр `fish_style_pwd_dir_length` , замість того, щоб приховувати скорочений шлях, ви побачите скорочену назву кожної теки в залежності від числа, яке ви вказали для цього параметра.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Наприклад, маємо `~/Dev/Nix/nixpkgs/pkgs` де `nixpkgs` є коренем репозиторію, а параметр — `1` . Ви побачите `~/D/N/nixpkgs/pkgs` , тоді як до цього було `nixpkgs/pkg` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `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) |
2022-10-15 01:53:32 +00:00
< details >
2023-04-12 18:43:40 +00:00
< summary > Цей модуль має декілька додаткових опцій, які контролюють показ шляхів до тек.< / summary >
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Додатковий параметр | Стандартно | Опис |
| --------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | Таблиця підстановок, які буде зроблена у шляху теки. |
| `fish_style_pwd_dir_length` | `0` | Кількість символів, які використовуються при застосуванні логіки шляху fish shell pwd. |
| `use_logical_path` | `true` | Якщо `true` показувати логічний шлях оболонки через `PWD` а б о `--logical-path` . Якщо `false` – показувати шлях фізичної файлової системи з розвʼязанням шляхів для символічних посилань. |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
`substitutions` дозволяє визначити довільні заміни літер рядків, що зустрічаються в шляху, наприклад, довга префікси мережа а б о теки розробки (в Java). Зауважте, що це відключить стиль fish у PWD.
2022-10-15 01:53:32 +00:00
```toml
[directory.substitutions]
2022-12-05 06:54:12 +00:00
'/Volumes/network/path' = '/net'
'src/com/long/java/path' = 'mypath'
2022-10-15 01:53:32 +00:00
```
2023-04-12 18:43:40 +00:00
`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` .
2022-10-15 01:53:32 +00:00
< / details >
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------------------- | --------------------------------------- |
2023-04-12 18:43:40 +00:00
| path | `'D:/Projects'` | Поточний шлях до теки |
2023-04-11 04:05:27 +00:00
| style\* | `'black bold dimmed'` | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
< details >
2023-04-12 18:43:40 +00:00
< summary > Git-репозиторії мають додаткові змінні.< / summary >
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Розгляньмо шлях `/path/to/home/git_repo/src/lib`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
2022-12-05 06:54:12 +00:00
| ------------------ | --------------------- | --------------------------------------- |
2023-04-12 18:43:40 +00:00
| before_root_path | `≠` | Шлях до кореневої теки git |
| repo_root | `'git_repo'` | Назва кореневої теки git |
| path | `'/src/lib'` | Залишок шляху |
2023-04-11 04:05:27 +00:00
| style | `'black bold dimmed'` | Віддзеркалює значення параметра `style` |
2023-04-12 18:43:40 +00:00
| repo_root_style | `'underline white'` | Стиль кореневої теки git |
2022-10-15 01:53:32 +00:00
< / details >
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[directory]
truncation_length = 8
2022-12-05 06:54:12 +00:00
truncation_symbol = '…/'
2022-10-15 01:53:32 +00:00
```
## Docker Context
2023-04-12 18:43:40 +00:00
Модуль `docker_context` показує поточний [Docker context ](https://docs.docker.com/engine/context/working-with-contexts/ ) якщо його не встановлено у `default` , а б о якщо `DOCKER_MACHINE_NAME` `DOCKER_HOST` а б о `DOCKER_CONTEXT` змінні середовища встановлені (оскільки вони призначені для перевизначення контексту).
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| context | `test_context` | Поточний docker context |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[docker_context]
2022-12-05 06:54:12 +00:00
format = 'via [🐋 $context ](blue bold )'
2022-10-15 01:53:32 +00:00
```
## Dotnet
2023-04-12 18:43:40 +00:00
Модуль `dotnet` показує відповідну версію [.NET Core SDK ](https://dotnet.microsoft.com/ ) для поточної теки. Якщо SDK закріплена в поточній теці, показується закріплена версія. В іншому випадку модуль покаже останню встановлену версію SDK.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Стандартно модуль буде показаний в командному рядку, коли один чи більше з наступних файлів є в теці:
2022-10-15 01:53:32 +00:00
- `global.json`
- `project.json`
- `Directory.Build.props`
- `Directory.Build.targets`
- `Packages.props`
- `*.csproj`
- `*.fsproj`
- `*.xproj`
2023-04-12 18:43:40 +00:00
Вам також знадобиться .NET Core SDK, встановлений для того, щоб використовувати його правильно.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Всередині, цей модуль використовує власний механізм для виявлення версій. Як правило, він удвічі швидший ніж запуск `dotnet --version` , але він може показувати некоректну версію, якщо ваш проєкт .NET має не звичайне розташування тек. Якщо точність важливіша за швидкість, ви можете вимкнути механізм встановивши `heuristic = false` в налаштуваннях модуля.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Модуль також показуватиме Target Framework Monamework ([https://docs.microsoft. om/en-us/dotnet/standard/frameworks#supported-target-frameworks](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks)), коли у поточній теці є файл `.csproj` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `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` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[dotnet]
2022-12-05 06:54:12 +00:00
symbol = '🥅 '
style = 'green'
2022-10-15 01:53:32 +00:00
heuristic = false
```
## Elixir
2023-04-12 18:43:40 +00:00
Модуль `elixir` показує поточну встановлену версію [Elixir ](https://elixir-lang.org/ ) та [Erlang/OTP ](https://erlang.org/doc/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `mix.exs` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| ----------- | ------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v1.10` | Версія `elixir` |
| otp_version | | Версія otp `elixir` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[elixir]
2022-12-05 06:54:12 +00:00
symbol = '🔮 '
2022-10-15 01:53:32 +00:00
```
## Elm
2023-04-12 18:43:40 +00:00
Модуль `elm` показує поточну встановлену версію [Elm ](https://elm-lang.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `elm.json`
- Поточна тека містить файл `elm-package.json`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.elm-version`
- Поточна тека містить файл `elm-stuff`
- The current directory contains `.elm` files
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | -------------------------------------------------- | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v0.19.1` | Версія `elm` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[elm]
2022-12-05 06:54:12 +00:00
format = 'via [ $version ](cyan bold ) '
2022-10-15 01:53:32 +00:00
```
## Environment Variable
2023-04-12 18:43:40 +00:00
Модуль `env_var` показує поточне значення обраних змінних середовища. Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Параметр `variable` відповідає наявній змінній середовища
- Параметр `variable` не визначено, але є параметр `default`
2022-10-15 01:53:32 +00:00
::: tip
2023-04-12 18:43:40 +00:00
Порядок в якому модуль env_var показується може встановлюватись індивідуально додавання `${env_var.foo}` в `format` верхнього рівня (через те, що використовуються крапки, потрібно використовувати `${...}` ). Типово, модуль `env_var` покаже у с і модулі env_var, в тому порядку того, як вони були визначені.
2023-01-31 16:14:38 +00:00
:::
::: tip
2023-04-12 18:43:40 +00:00
Кілька змінних оточення можуть бути показані за допомоги `.` . (див. приклад) Якщо опції конфігурації `variable` не встановлено, модуль показуватиме значення змінної після символу `.` під назвою.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
Приклад: наступна конфігурація показуватиме значення змінної середовища USER
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[env_var.USER]
2022-12-05 06:54:12 +00:00
default = 'unknown user'
2022-10-15 01:53:32 +00:00
```
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------- | ------------------------------ | ----------------------------------------------------------------------- |
| `symbol` | `""` | Символ, який знаходиться перед значенням variable. |
| `variable` | | Змінна середовища для показу. |
| `default` | | Стандартне значення буде показане, якщо змінні для показу не визначені. |
| `format` | `"with [$env_value]($style) "` | Формат модуля. |
| `description` | `"<env_var module>"` | Опис модуля, який показується під час запуску `starship explain` . |
| `disabled` | `false` | Вимикає модуль `env_var` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Змінна | Приклад | Опис |
| --------- | ----------------------------------------- | ------------------------------------------------ |
| env_value | `Windows NT` (якщо _variable_ буде `$OS` ) | Значення змінної оточення з параметра `variable` |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | `black bold dimmed` | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[env_var]
2022-12-05 06:54:12 +00:00
variable = 'SHELL'
default = 'unknown shell'
2022-10-15 01:53:32 +00:00
```
2023-04-12 18:43:40 +00:00
Показ кількох змінних оточення:
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[env_var.SHELL]
2022-12-05 06:54:12 +00:00
variable = 'SHELL'
default = 'unknown shell'
2022-10-15 01:53:32 +00:00
[env_var.USER]
2022-12-05 06:54:12 +00:00
default = 'unknown user'
2022-10-15 01:53:32 +00:00
```
## Erlang
2023-04-12 18:43:40 +00:00
Модуль `erlang` показує поточну встановлену версію [Erlang/OTP ](https://erlang.org/doc/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `rebar.config` .
- Поточна тека містить файл `erlang.mk` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `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` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v22.1.3` | Версія `erlang` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[erlang]
2022-12-05 06:54:12 +00:00
format = 'via [e $version ](bold red ) '
2022-10-15 01:53:32 +00:00
```
2023-01-31 16:14:38 +00:00
## Fennel
2023-04-12 18:43:40 +00:00
Модуль `fennel` показує поточну встановлену версію [Fennel ](https://fennel-lang.org ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.fnl`
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `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` . |
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| version | `v1.2.1` | Версія `fennel` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2023-01-31 16:14:38 +00:00
```toml
# ~/.config/starship.toml
[fennel]
symbol = '⫰ '
```
2022-10-15 01:53:32 +00:00
## Fill
2023-04-12 18:43:40 +00:00
Модуль `fill` заповнює простір в рядку вказаним символом. Якщо використовується кілька модулів `fill` , вони можуть заповнювати рядок рівномірно розподіляючи його довжину між собою. Це корисно для форматування інших модулів.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ---------- | -------------- | --------------------------------------------------- |
| `symbol` | `'.'` | Символ, який використовується для заповнення рядка. |
| `style` | `'bold black'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `fill` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
2022-12-05 06:54:12 +00:00
format = 'AA $fill BB $fill CC'
2022-10-15 01:53:32 +00:00
[fill]
2022-12-05 06:54:12 +00:00
symbol = '-'
style = 'bold green'
2022-10-15 01:53:32 +00:00
```
2023-04-12 18:43:40 +00:00
Створить рядок, що виглядатиме наступним чином:
2022-10-15 01:53:32 +00:00
```
AA -------------------------------------------- BB -------------------------------------------- CC
```
2023-01-31 16:14:38 +00:00
## Fossil Branch
2023-04-12 18:43:40 +00:00
Модуль `fossil_branch` показує назву активної гілки у вашій поточній теці.
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol$branch]($style) '` | Формат модуля. Використовуйте `'$branch` для посилання на поточну гілку. |
| `symbol` | `' '` | Символ, що використовується перед назвою гілки у вашій поточній теці. |
| `style` | `'bold purple'` | Стиль модуля. |
| `truncation_length` | `2^63 - 1` | Скорочує назву гілки Fossil до `N` графем |
| `truncation_symbol` | `'…'` | Символ, що використовується для позначення назви гілки, яка була скорочена. Ви можете використовувати `''` , щоб нічого не показувати. |
| `disabled` | `true` | Вимикає модуль `fossil_branch` . |
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
2023-04-12 18:43:40 +00:00
| branch | `trunk` | Поточна гілка Fossil |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2023-01-31 16:14:38 +00:00
```toml
# ~/.config/starship.toml
[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''
```
2023-09-02 07:31:36 +00:00
## Fossil Metrics
2023-09-06 18:28:18 +00:00
Модуль `fossil_metrics` покаже кількість доданих та видалених рядків у поточній теці. Потрібна версія Fossil не нижче v2.14 (2021-01-20).
2023-09-02 07:31:36 +00:00
### Параметри
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| -------------------- | ------------------------------------------------------------ | -------------------------------------------- |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. |
| `added_style` | `'bold green'` | Стиль для показу кількості доданих рядків. |
| `deleted_style` | `'bold red'` | Стиль для показу кількості видалених рядків. |
| `only_nonzero_diffs` | `true` | Показувати стан лише для змінених елементів. |
2023-09-06 18:28:18 +00:00
| `disabled` | `true` | Вимикає модуль `fossil_metrics` . |
2023-09-02 07:31:36 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ----------------- | ------- | ----------------------------------------------- |
| added | `1` | Поточна кількість доданих рядків |
| deleted | `2` | Поточна кількість видалених рядків |
| added_style\* | | Віддзеркалює значення параметра `added_style` |
| deleted_style\* | | Віддзеркалює значення параметра `deleted_style` |
2023-09-02 07:31:36 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
### Приклад
```toml
# ~/.config/starship.toml
[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
```
2022-10-15 01:53:32 +00:00
## Google Cloud (`gcloud`)
2023-09-03 01:08:16 +00:00
Модуль `gcloud` показує поточну конфігурацію [`gcloud` ](https://cloud.google.com/sdk/gcloud ) CLI. Він базується на файлі `~/.config/gcloud/active_config` та на `~/.config/gcloud/configurations/config_{CONFIG NAME}` і на змінній оточення `CLOUDSDK_CONFIG` .
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Коли модуль увімкнено, він завжди буде активним, якщо не встановлено параметр `detect_env_vars` , в такому випадку модуль буде активним лише коли буде встановлено одну зі змінних середовища.
2023-06-06 14:10:23 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Формат модуля. |
| `symbol` | `'☁️ '` | Символ, який використовується під час показу перед поточним профілем GCP. |
| `region_aliases` | `{}` | Таблиця псевдонімів регіону для показу на додачу до назви GCP. |
| `project_aliases` | `{}` | Таблиця псевдонімів проєкту для показу на додачу до назви GCP. |
| `detect_env_vars` | `[]` | Які змінні середовища повинні запускати цей модуль |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `gcloud` . |
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| --------- | ------------- | -------------------------------------------------------------- |
| region | `us-central1` | Поточний регіон GCP |
| account | `foo` | Поточний профіль GCP |
| domain | `example.com` | Поточний домен профілю GCP |
| project | | Поточний проєкт GCP |
| active | `default` | Назва активної конфігурації з `~/.config/gcloud/active_config` |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклади
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
#### Показувати обліковий запис та проєкт
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\)) ]($style ) '
```
2023-04-12 18:43:40 +00:00
#### Показувати тільки назву активної конфігурації
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[gcloud]
2022-12-05 06:54:12 +00:00
format = '[$symbol$active]($style) '
style = 'bold yellow'
2022-10-15 01:53:32 +00:00
```
2023-04-12 18:43:40 +00:00
#### Показувати обліковий запис та псевдо регіону
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[gcloud]
2022-12-05 06:54:12 +00:00
symbol = '️🇬️ '
2022-10-15 01:53:32 +00:00
[gcloud.region_aliases]
2022-12-05 06:54:12 +00:00
us-central1 = 'uc1'
asia-northeast1 = 'an1'
2022-10-15 01:53:32 +00:00
```
2023-04-12 18:43:40 +00:00
#### Показувати обліковий запис та псевдо проєкту
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\)) ]($style ) '
[gcloud.project_aliases]
2022-12-05 06:54:12 +00:00
very-long-project-name = 'vlpn'
2022-10-15 01:53:32 +00:00
```
## Git Branch
2023-09-03 01:08:16 +00:00
Модуль `git_branch` показує активну гілку репозиторію у вашій поточній теці.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
2023-09-03 01:08:16 +00:00
| `always_show_remote` | `false` | Показує назву віддаленої відстежуваної гілки, навіть якщо вона збігається з назвою локальної гілки. |
2023-04-12 18:43:40 +00:00
| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Формат модуля. Використовуйте `'$branch` для посилання на поточну гілку. |
2023-09-03 01:08:16 +00:00
| `symbol` | `' '` | Формат рядка, що представляє символ гілки git. |
2023-04-12 18:43:40 +00:00
| `style` | `'bold purple'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `truncation_length` | `2^63 - 1` | Скорочує назву гілки git до `N` графем. |
2023-04-12 18:43:40 +00:00
| `truncation_symbol` | `'…'` | Символ, що використовується для позначення назви гілки, яка була скорочена. Ви можете використовувати `''` , щоб нічого не показувати. |
2023-09-03 01:08:16 +00:00
| `only_attached` | `false` | Показувати назву гілки тільки коли вона не у відʼєднаному від `HEAD` стані. |
| `ignore_branches` | `[]` | Перелік назв, які не треба показувати. Корисно для 'master' а б о 'main'. |
| `disabled` | `false` | Вимикає модуль `git_branch` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
2022-10-15 01:53:32 +00:00
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
2023-09-03 01:08:16 +00:00
| branch | `master` | Назва поточної гілки, показується `HEAD` , якщо зараз немає поточної гілки (напр. git detached `HEAD` ). |
| remote_name | `origin` | Назва віддаленої гілки. |
| remote_branch | `master` | Назва гілки, що відстежується у `remote_name` . |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[git_branch]
2022-12-05 06:54:12 +00:00
symbol = '🌱 '
2022-10-15 01:53:32 +00:00
truncation_length = 4
2022-12-05 06:54:12 +00:00
truncation_symbol = ''
ignore_branches = ['master', 'main']
2022-10-15 01:53:32 +00:00
```
## Git Commit
2023-09-03 01:08:16 +00:00
Модуль `git_commit` показує поточний хеш коміту, а також теґ (якщо він є) репозиторію у вашій поточній теці.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| -------------------- | ------------------------------ | -------------------------------------------------------------------------------------------- |
| `commit_hash_length` | `7` | Довжина хешу коміта. |
| `format` | `'[\($hash$tag\)]($style) '` | Формат модуля. |
| `style` | `'bold green'` | Стиль модуля. |
| `only_detached` | `true` | Показувати хеш коміту тільки коли `HEAD` у відʼєднаному стані |
| `tag_disabled` | `true` | Вимикає показ теґів в модулі `git_commit` . |
| `tag_max_candidates` | `0` | Впродовж скількох комітів показувати теґ. Стандартно дозволяється тільки безпосередній збіг. |
| `tag_symbol` | `' 🏷 '` | Символ теґу |
| `disabled` | `false` | Вимикає модуль `git_commit` . |
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------------------- |
| hash | `b703eb3` | Хэш коміту git |
| tag | `v1.0.0` | Назва теґу, якщо увімкнено показ інформації про теґ. |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
2022-12-05 06:54:12 +00:00
tag_symbol = '🔖 '
2022-10-15 01:53:32 +00:00
```
## Git State
2023-09-03 01:08:16 +00:00
Модуль `git_state` показується в теках, які є частиною репозиторію git, під час виконання операцій на зразок _REBASING_ , _BISECTING</ 1 > тощо. Інформація про прогрес операції (наприклад, REBASING 3/10), також буде показана якщо вона доступна.</ p >
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| -------------- | --------------------------------------------------------------- | ------------------------------------------------------------ |
| `rebase` | `'REBASING'` | Формат рядка під час процесу `rebase` . |
| `merge` | `'MERGING'` | Формат рядка під час процесу `merge` . |
| `revert` | `'REVERTING'` | Формат рядка під час процесу `revert` . |
| `cherry_pick` | `'CHERRY-PICKING'` | Формат рядка під час процесу `cherry-pick` . |
| `bisect` | `'BISECTING'` | Формат рядка під час процесу `bisect` . |
| `am` | `'AM'` | Формат рядка під час процесу `apply-mailbox` (`git am`). |
| `am_or_rebase` | `'AM/REBASE'` | Формат рядка під час процесу `apply-mailbox` а б о `rebase` . |
| `style` | `'bold yellow'` | Стиль модуля. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Формат модуля. |
| `disabled` | `false` | Вимикає модуль `git_state` . |
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| ---------------- | ---------- | --------------------------------------- |
2023-09-03 01:08:16 +00:00
| state | `REBASING` | Поточний стан репозиторію |
| progress_current | `1` | Прогрес поточної операції |
| progress_total | `2` | Загальний прогрес операції |
2023-04-11 04:05:27 +00:00
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
2022-12-05 06:54:12 +00:00
cherry_pick = '[🍒 PICKING](bold red)'
2022-10-15 01:53:32 +00:00
```
## Git Metrics
2023-09-03 01:08:16 +00:00
Модуль `git_metrics` покаже кількість доданих та видалених рядків у поточному репозиторії git.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| -------------------- | ------------------------------------------------------------ | -------------------------------------------- |
| `added_style` | `'bold green'` | Стиль для показу кількості доданих рядків. |
| `deleted_style` | `'bold red'` | Стиль для показу кількості видалених рядків. |
| `only_nonzero_diffs` | `true` | Показувати стан лише для змінених елементів. |
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Формат модуля. |
| `disabled` | `true` | Вимикає модуль `git_metrics` . |
| `ignore_submodules` | `false` | Ігнорувати зміни в субмодулях |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ----------------- | ------- | ----------------------------------------------- |
| added | `1` | Поточна кількість доданих рядків |
| deleted | `2` | Поточна кількість видалених рядків |
| added_style\* | | Віддзеркалює значення параметра `added_style` |
| deleted_style\* | | Віддзеркалює значення параметра `deleted_style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[git_metrics]
2022-12-05 06:54:12 +00:00
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
2022-10-15 01:53:32 +00:00
```
## Git Status
2023-09-03 01:08:16 +00:00
Модуль `git_status` показує символ, що описує стан репозиторію в поточній теці.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
Модуль Git Status дуже повільно працює в теках Windows у середовищі WSL (наприклад, під `/mnt/c/` ). Ви можете вимкнути модуль а б о використати `windows_starship` для використання Windows-native Starship `git_status` для цих шляхів.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | Стандартний формат `git_status` |
| `conflicted` | `'='` | Ця гілка конфлікт злиття. |
| `ahead` | `'⇡'` | Формат `ahead` |
| `behind` | `'⇣'` | Формат `behind` |
| `diverged` | `'⇕'` | Формат `diverged` |
| `up_to_date` | `''` | Формат `up_to_date` |
| `untracked` | `'?'` | Формат `untracked` |
| `stashed` | `'$'` | Формат `stashed` |
| `modified` | `'!'` | Формат `modified` |
| `staged` | `'+'` | Формат `staged` |
| `renamed` | `'»'` | Формат `renamed` |
| `deleted` | `'✘'` | Формат `deleted` |
| `typechanged` | `""` | Формат `typechange` |
| `style` | `'bold red'` | Стиль модуля. |
| `ignore_submodules` | `false` | Ігнорувати зміни в субмодулях. |
| `disabled` | `false` | Вимикає модуль `git_status` . |
| `windows_starship` | | Використовуйте цей (Linux) шлях до виконуваного файлу у Windows для показу `git_status` у випадку шляхів Windows у WSL. |
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
Наступні змінні можуть бути використані у `format` :
| Змінна | Опис |
| -------------- | --------------------------------------------------------------------------------------------------- |
| `all_status` | Скорочення для `$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
| `ahead_behind` | Показує `diverged` , `ahead` , `behind` чи `up_to_date` в залежності від поточного стану репозиторію. |
| `conflicted` | Показує `conflicted` , коли поточна гілка має конфлікт злиття. |
| `untracked` | Показує `untracked` коли в робочій теці є файли що ще не включені до відстеження у репозиторії. |
| `stashed` | Показує `stashed` за наявності stash у локальному репозиторії. |
| `modified` | Показує `modified` коли в робочій теці є змінені файли. |
| `staged` | Показує `staged` , коли нові фали були додані до простору staging. |
| `renamed` | Показує `renamed` коли перейменовані файли було додано до простору staging. |
| `deleted` | Показує `deleted` коли інформація про видалення файлів була додана до простору staging. |
| `typechanged` | Показує `typechange` коли інформація про файл була змінена у просторі staging. |
| style\* | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Наступні змінні можуть бути використані у `diverged` :
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Опис |
| -------------- | ---------------------------------------------------------------- |
| `ahead_count` | Кількість комітів на яку поточна гілка випереджає відстежувану |
| `behind_count` | Кількість комітів на яку поточна гілка відстає від відстежуваної |
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Наступні змінні можуть використовуватись у `conflicted` , `ahead` , `behind` , `untracked` , `stashed` , `modified` , `staged` , `renamed` та `deleted` :
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Опис |
| ------- | ------------------------ |
2023-09-03 01:08:16 +00:00
| `count` | Показує кількість файлів |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[git_status]
2022-12-05 06:54:12 +00:00
conflicted = '🏳'
ahead = '🏎💨'
behind = '😰'
diverged = '😵'
up_to_date = '✓'
untracked = '🤷'
stashed = '📦'
modified = '📝'
2022-10-15 01:53:32 +00:00
staged = '[++\($count\)](green)'
2022-12-05 06:54:12 +00:00
renamed = '👅'
deleted = '🗑'
2022-10-15 01:53:32 +00:00
```
2023-09-03 01:08:16 +00:00
Показує кількість комітів ahead/behind
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[git_status]
2022-12-05 06:54:12 +00:00
ahead = '⇡${count}'
diverged = '⇕⇡${ahead_count}⇣${behind_count}'
behind = '⇣${count}'
2022-10-15 01:53:32 +00:00
```
2023-09-03 01:08:16 +00:00
Використання виконавчого файлу Windows Starship у Windows у шляхах WSL
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[git_status]
2022-12-05 06:54:12 +00:00
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'
2022-10-15 01:53:32 +00:00
```
## Go
2023-09-03 01:08:16 +00:00
Модуль `golang` показує поточну встановлену версію [Go ](https://golang.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `go.mod`
- Поточна тека містить файл `go.sum`
- Поточна тека містить файл `go.work`
- Поточна тека містить файл `glide.yaml`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `Gopkg.yml`
- Поточна тека містить файл `Gopkg.lock`
- Поточна тека містить файл `.go-version`
- Поточна тека містить теку `Godeps`
- Поточна тека містить файл `.go`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
| `symbol` | `'🐹 '` | Формат рядка, що представляє символ 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'` | Стиль модуля, коли директиви go з файлу go.mod не збігаються з встановленою версією Go. |
| `disabled` | `false` | Вимикає модуль `golang` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- |
| version | `v1.12.1` | Версія `go` |
| mod_version | `1.16` | вимоги до версії `go` , як зазначено у директиві `go.mod` . Буде показано лише коли потрібна версія не збігається з версією `go` . |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[golang]
2022-12-05 06:54:12 +00:00
format = 'via [🏎💨 $version ](bold cyan ) '
```
2023-09-03 01:08:16 +00:00
### Використання `mod_version`
2023-06-06 14:10:23 +00:00
```toml
# ~/.config/starship.toml
[golang]
format = 'via [$symbol($version )($mod_version ) ]($style )'
```
2022-12-05 06:54:12 +00:00
## Guix-shell
2023-09-03 01:08:16 +00:00
Модуль `guix_shell` показує середовище [guix-shell ](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html ). Модуль буде показано, коли ви перебуваєте в середовищі guix-shell.
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-12-05 06:54:12 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------- | -------------------------- | ----------------------------------------------- |
| `format` | `'via [$symbol]($style) '` | Формат модуля. |
| `symbol` | `"🐃 "` | Формат рядка, що представляє символ guix-shell. |
| `style` | `"yellow bold"` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `guix_shell` . |
2022-12-05 06:54:12 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-12-05 06:54:12 +00:00
```toml
# ~/.config/starship.toml
[guix_shell]
disabled = true
format = 'via [🐂 ](yellow bold ) '
2022-10-15 01:53:32 +00:00
```
2023-01-31 16:14:38 +00:00
## Gradle
2023-09-03 01:08:16 +00:00
Модуль `gradle` показує версію [Gradle Wrapper ](https://docs.gradle.org/current/userguide/gradle_wrapper.html ) що використовується в теці проєкту.
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить теку `gradle/wrapper/gradle-wrapper.properties` .
- Поточна тека містить файли `.gradle` а б о `.gradle.kts` .
2023-01-31 16:14:38 +00:00
2023-09-03 01:08:16 +00:00
Модуль `gradle` може лише зчитувати версію Gradle Wrapper з вашого файлу налаштувань, ми не запускаємо на виконання вашу обгортку з міркувань безпеки.
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${raw}"` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `"🅶 "` | Формат рядка, що представляє символ Gradle. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `["gradle", "gradle.kts"]` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `["gradle"]` | В яких теках цей модуль має запускатись. |
| `style` | `"bold bright-cyan"` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `gradle` . |
| `recursive` | `false` | Дозволяє рекурсивний пошук теки `gradle` . |
2023-01-31 16:14:38 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| ------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v7.5.1` | Версія `gradle` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style* | | Віддзеркалює значення параметра `style` |
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2023-01-31 16:14:38 +00:00
2022-10-15 01:53:32 +00:00
## Haskell
2023-09-03 01:08:16 +00:00
Модуль `haskell` знаходить поточну версію GHC та/а б о Stack snapshot.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `stack.yaml`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли `.hs` , `.cabal` а б о `.hs-boot`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | -------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `symbol` | `'λ '` | Формат рядка, що представляє символ Haskell |
| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['stack.yaml', 'cabal.project']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'bold purple'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `haskell` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
2022-12-05 06:54:12 +00:00
| -------------- | ----------- | --------------------------------------------------------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | | `ghc_version` а б о `snapshot` в залежності від того, чи є поточний проєкт проєктом Stack |
| snapshot | `lts-18.12` | Поточний обраний Stack snapshot |
| ghc\_version | `9.2.1` | Встановлена версія GHC |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2022-12-05 06:54:12 +00:00
## Haxe
2023-09-03 01:08:16 +00:00
Модуль `haxe` показує поточну встановлену версію [Haxe ](https://haxe.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-12-05 06:54:12 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли `project.xml` , `Project.xml` , `додаток. ml` , `haxelib.json` , `hxformat.json` а б о `.haxerc`
- Поточна тека містить теку `.haxelib` а б о `haxe_libraries`
- Поточна тека містить файли `.hx` а б о `.hxml`
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-12-05 06:54:12 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `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"` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `haxe` . |
2022-12-05 06:54:12 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v4.2.5` | Версія `haxe` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-12-05 06:54:12 +00:00
```toml
# ~/.config/starship.toml
[haxe]
format = "via [⌘ $version ](bold fg:202 ) "
```
2022-10-15 01:53:32 +00:00
## Helm
2023-09-03 01:08:16 +00:00
Модуль `helm` показує поточну встановлену версію [Helm ](https://helm.sh/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `helmfile.yaml`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `Chart.yaml`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `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'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `helm` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v3.1.1` | Версія `helm` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[helm]
2022-12-05 06:54:12 +00:00
format = 'via [⎈ $version ](bold white ) '
2022-10-15 01:53:32 +00:00
```
## Hostname
2023-09-03 01:08:16 +00:00
Модуль `hostname` показує назву хосту.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-17 00:31:34 +00:00
| Параметр | Стандартно | Опис |
| ----------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Показувати назву хоста лише при підключенні через SSH. |
| `ssh_symbol` | `'🌐 '` | Формат рядка для показу символу підключення до SSH-сеансу. |
| `trim_at` | `'.'` | Рядок, у якому назва хоста буде обрізано після першого збігу. `'.'` зупиниться після першої точки. `''` вимкне будь-яке скорочення. |
2023-09-17 19:40:06 +00:00
| `detect_env_vars` | `[]` | Які змінні середовища повинні запускати цей модуль. |
2023-09-17 00:31:34 +00:00
| `format` | `'[$ssh_symbol$hostname]($style) in '` | Формат модуля. |
| `style` | `'bold dimmed green'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `hostname` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ---------- | ---------- | ------------------------------------------------------------- |
| hostname | `computer` | Назва хосту |
| style\* | | Віддзеркалює значення параметра `style` |
| ssh_symbol | `'🌏 '` | Символ, який буде показаний, під час підʼєднання до SSH сесії |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-09-16 14:59:43 +00:00
### Приклади
2023-09-17 19:40:06 +00:00
#### Завжди показувати hostname
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
2022-12-05 06:54:12 +00:00
format = '[$ssh_symbol](bold blue) on [$hostname ](bold red ) '
trim_at = '.companyname.com'
2022-10-15 01:53:32 +00:00
disabled = false
```
2023-09-17 19:40:06 +00:00
#### Приховувати hostname для віддалених сеансів tmux
2023-09-16 14:59:43 +00:00
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
disabled = false
```
2022-10-15 01:53:32 +00:00
## Java
2023-09-03 01:08:16 +00:00
Модуль `java` показує поточну встановлену версію [Java ](https://www.oracle.com/java/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- В поточній теці містяться файли `pom.xml` , `build.gradle.kts` , `build.sbt` , `.java-version` , `deps.edn` , `project.clj` , `build.boot` а б о `.sdkmanrc`
- Поточна тека містить файли з розширеннями `.java` , `.class` , `.gradle` , `.jar` , `.clj` а б о `.cljc`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `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` | `[]` | Які теки мають запускати цей модуль. |
2023-09-03 01:08:16 +00:00
| `symbol` | `'☕ '` | Формат рядка, що представляє символ Java |
2023-04-12 18:43:40 +00:00
| `style` | `'red dimmed'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `java` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v14` | Версія `java` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[java]
2022-12-05 06:54:12 +00:00
symbol = '🌟 '
2022-10-15 01:53:32 +00:00
```
## Jobs
2023-09-03 01:08:16 +00:00
Модуль `jobs` показує поточну кількість завдань, що виконуються зараз. Модуль показуватиметься лише у випадку наявності фонових завдань. Модуль покаже кількість запущених завдань, якщо є хоча б 2 завдання, а б о більше за значення в `number_threshold` , за наявності. Модуль покаже символ, якщо є принаймні одне, чи більше за значення `symbol_threshold` , фонове завдання. Ви можете встановити обидва значення в 0, щоб _за вжди_ показувати символ і кількість завдань, навіть якщо виконується 0 завдань.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Стандартний функціонал:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- 0 завдань -> нічого не показується.
- 1 завдання -> показується `symbol` .
- 2 чи більше завдань -> показується `symbol` + `число` .
2022-10-15 01:53:32 +00:00
::: warning
2023-09-03 01:08:16 +00:00
Модуль не підтримується в tcsh та nu.
2022-10-15 01:53:32 +00:00
:::
::: warning
2023-09-03 01:08:16 +00:00
Параметр `threshold` є застарілим, але якщо ви бажаєте його використовувати, модуль буде показувати кількість запущених завдань, якщо у вас більше одного фонового завдання, а б о завдань більше за `threshold` . Якщо `threshold` встановлено у 0, то модуль також показуватиметься, коли немає запущених завдань.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------------- |
| `threshold` * | `1` | Показувати кількість завдань, якщо вони перевищують значення. |
| `symbol_threshold` | `1` | Показувати символ `symbol` , якщо кількість завдань не менше `symbol_threshold` . |
| `number_threshold` | `2` | Показувати кількість завдань, якщо їх кількість не менша за `number_threshold` . |
| `format` | `'[$symbol$number]($style) '` | Формат модуля. |
| `symbol` | `'✦'` | Змінна для визначення символу `symbol` . |
| `style` | `'bold blue'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `jobs` . |
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
*: Цей параметр застарів, використовуйте параметри `number_threshold` і `symbol_threshold` замість цього.
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| number | `1` | Кількість завдань |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[jobs]
2023-09-17 00:31:34 +00:00
символ = '+ '
2022-10-15 01:53:32 +00:00
number_threshold = 4
symbol_threshold = 0
```
## Julia
2023-09-03 01:08:16 +00:00
Модуль `julia` показує поточну встановлену версію [Julia ](https://julialang.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `Project.toml`
- Поточна тека містить файл `Manifest.toml`
- Поточна тека містить файл `.jl`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
| `detect_extensions` | `['jl']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['Project.toml', 'Manifest.toml']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | Які теки мають запускати цей модуль. |
2023-09-03 01:08:16 +00:00
| `symbol` | `'ஃ '` | Формат рядка, що представляє символ Julia. |
2023-04-12 18:43:40 +00:00
| `style` | `'bold purple'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `julia` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v1.4.0` | Версія `julia` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[julia]
2022-12-05 06:54:12 +00:00
symbol = '∴ '
2022-10-15 01:53:32 +00:00
```
## Kotlin
2023-09-03 01:08:16 +00:00
Модуль `kotlin` показує поточну встановлену версію [Kotlin ](https://kotlinlang.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли, `.kt` а б о `.kts`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
| `detect_extensions` | `['kt', 'kts']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | Які теки мають запускати цей модуль. |
| `symbol` | `'🅺 '` | Формат рядка, що представляє символ Kotlin. |
| `style` | `'bold blue'` | Стиль модуля. |
| `kotlin_binary` | `'kotlin'` | Налаштовує бінарний файл kotlin, який Starship буде використовувати для отримання версії. |
| `disabled` | `false` | Вимикає модуль `kotlin` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v1.4.21` | Версія `kotlin` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[kotlin]
2022-12-05 06:54:12 +00:00
symbol = '🅺 '
2022-10-15 01:53:32 +00:00
```
```toml
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
2022-12-05 06:54:12 +00:00
kotlin_binary = 'kotlinc'
2022-10-15 01:53:32 +00:00
```
## Kubernetes
2023-09-06 19:27:51 +00:00
Показує поточну назву [Kubernetes context ](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context ) та, якщо встановлено, простір імен, користувача та кластер з файлу kubeconfig. Простір імен повинен бути встановлений у файлі kubeconfig файл, це можна зробити через `kubectl config set-context starship-context --namespace astronaut` . Так само можна встановити користувача та кластер за допомогою `kubectl config set-context starship-context --user starship-user` та `kubectl config set-context context context context --cluster starship-cluster` , відповідно. Якщо параметр `$KUBECONFIG` встановлено, то модуль буде використовувати його, якщо ні — `~/.kube/config` .
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Коли модуль увімкнено, він завжди буде активним, якщо будь-який з параметрів `detect_extensions` , `detect_files` а б о `detect_folders` встановлені, модуль буде активним тільки в теках, що відповідають умовам.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-02 07:31:36 +00:00
::: warning
2023-09-06 19:27:51 +00:00
Параметри `context_aliases` та `user_aliases` є застарілими. Використовуйте `contexts` та, відповідно, `context_alias` та `user_alias` , натомість.
2023-09-02 07:31:36 +00:00
:::
2023-09-06 19:27:51 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------- |
| `symbol` | `'☸ '` | Символ, що показується перед Кластером. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Формат модуля. |
| `style` | `'cyan bold'` | Стиль модуля. |
| `context_aliases` * | `{}` | Таблиця контекстних псевдонімів. |
| `user_aliases` * | `{}` | Таблиця псевдонімів користувача. |
| `detect_extensions` | `[]` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | Які теки мають запускати цей модуль. |
| `contexts` | `[]` | Кастомізовані стилі та символи для конкретних контекстів. |
| `disabled` | `true` | Вимикає модуль `kubernetes` . |
*: Цей параметр є застарілими, додайте `contexts` , відповідно, `context_alias` та `user_alias` , натомість.
Для налаштування стилю модуля для конкретних середовищ використовуйте наступну конфігурацію як частину списку `contexts` :
| Змінна | Опис |
| ----------------- | --------------------------------------------------------------------------------------------------------- |
| `context_pattern` | **Обовʼязково** Регулярний вираз, що повертає збіг з назвою поточного контексту Kubernetes. |
| `user_pattern` | Регулярний вираз, що відповідає поточному імені користувача Kubernetes. |
| `context_alias` | Псевдонім контексту для показу замість назви повного контексту. |
| `user_alias` | Псевдонім користувача для показу замість повного імені користувача. |
| `style` | Стиль для модуля, при використанні цього контексту. Якщо не вказано, використовуватиметься стиль модуля. |
| `symbol` | Символ для модуля при використанні цього контексту. Якщо не вказано, використовуватиметься символ модуля. |
Зверніть увагу, що всі регулярні вирази виглядають як `^<pattern>$` і мають збігатись з усім рядком. Регулярний вираз `*_pattern` може мати групи, які можуть зазначатись у відповідних аліасах як `$name` та `$N` (дивіться приклад нижче та [документації rust Regex::replace() ](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace )).
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| --------- | -------------------- | -------------------------------------------------- |
| context | `starship-context` | Поточна назва kubernetes context |
| namespace | `starship-namespace` | Якщо встановлено, поточний простір імен kubernetes |
| user | `starship-user` | Якщо встановлено, поточний користувач kubernetes |
| cluster | `starship-cluster` | Якщо встановлено, поточний кластер kubernetes |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\) ](dimmed green ) '
disabled = false
2023-09-02 07:31:36 +00:00
contexts = [
{ context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
]
2022-10-15 01:53:32 +00:00
```
2023-09-03 01:08:16 +00:00
Показує модуль лише у теках, що містять файл `k8s` .
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[kubernetes]
disabled = false
detect_files = ['k8s']
```
2023-09-17 00:31:34 +00:00
#### Kubernetes Context спец налаштування
2022-10-15 01:53:32 +00:00
2023-09-06 19:27:51 +00:00
Параметр `contexts` використовується для налаштування того, як виглядає назва контексту Kubernetes (стиль та символ), якщо назва збігається з визначеною регулярним виразом.
2022-10-15 01:53:32 +00:00
```toml
2023-09-02 07:31:36 +00:00
# ~/.config/starship.toml
2022-10-15 01:53:32 +00:00
2023-09-02 07:31:36 +00:00
[[kubernetes.contexts]]
2023-09-17 00:31:34 +00:00
# стиль "bold red" + типовий символ, коли назва поточного контексту Kubernetes збігається з "production" *та* поточний користувач
# збігається з "admin_user"
2023-09-02 07:31:36 +00:00
context_pattern = "production"
user_pattern = "admin_user"
style = "bold red"
context_alias = "prod"
user_alias = "admin"
[[kubernetes.contexts]]
2023-09-17 00:31:34 +00:00
# стиль "green" + інший символ, коли назва поточного контексту Kubernetes містить openshift
2023-09-02 07:31:36 +00:00
context_pattern = ".*openshift.*"
style = "green"
symbol = "💔 "
context_alias = "openshift"
[[kubernetes.contexts]]
2023-09-17 00:31:34 +00:00
# Використання груп
# Контекст з GKE, AWS та інших хмарних постачальників зазвичай має додаткову інформацію, наприклад регіон/зону.
# Наступний елемент збігається з форматом GKE format (`gke_projectname_zone_cluster-name`)
# та змінює кожний відповідний kube context на більш зрозумілий формат (`gke-cluster-name`):
2023-09-02 07:31:36 +00:00
context_pattern = "gke_.*_(?P< cluster > [\\w-]+)"
context_alias = "gke-$cluster"
2022-10-15 01:53:32 +00:00
```
## Line Break
2023-09-03 01:08:16 +00:00
Модуль `line_break` розділяє командний рядок на два рядки.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------- | ---------- | ---------------------------------------------------------- |
| `disabled` | `false` | Вимикає модуль `line_break` , перемикає вивід в один рядок. |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[line_break]
disabled = true
```
## Local IP
2023-09-03 01:08:16 +00:00
Модуль `localip` показує IPv4 адресу основного мережевого інтерфейсу.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------- | ------------------------- | ---------------------------------------------------- |
| `ssh_only` | `true` | Показувати IP адресу лише при підключенні через SSH. |
| `format` | `'[$localipv4]($style) '` | Формат модуля. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `true` | Вимикає модуль `localip` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------------ | --------------------------------------- |
2023-09-03 01:08:16 +00:00
| localipv4 | 192.168.1.13 | Містить основну адресу IPv4 |
2023-04-11 04:05:27 +00:00
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[localip]
ssh_only = false
2022-12-05 06:54:12 +00:00
format = '@[$localipv4](bold red) '
2022-10-15 01:53:32 +00:00
disabled = false
```
## Lua
2023-09-03 01:08:16 +00:00
Модуль `lua` показує поточну встановлену версію [Lua ](http://www.lua.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.lua-version`
- Поточна тека містить теку `lua`
- Поточна тека містить файли з розширенням `.lua`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
| `symbol` | `'🌙 '` | Формат рядка, що представляє символ Lua. |
| `detect_extensions` | `['lua']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['.lua-version']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `['lua']` | В яких теках цей модуль має запускатись. |
| `style` | `'bold blue'` | Стиль модуля. |
| `lua_binary` | `'lua'` | Налаштовує бінарний файл lua, який Starship буде використовувати для отримання версії. |
| `disabled` | `false` | Вимикає модуль `lua` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v5.4.0` | Версія `lua` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[lua]
2022-12-05 06:54:12 +00:00
format = 'via [🌕 $version ](bold blue ) '
2022-10-15 01:53:32 +00:00
```
## Memory Usage
2023-09-03 01:08:16 +00:00
Модуль `memory_usage` показує поточне використання оперативної памʼяті та памʼяті файлу підкачки.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Стандартно використання файлу підкачки показується якщо його розмір не є нульовим.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ----------- | ----------------------------------------------- | ---------------------------------------------------------------- |
| `threshold` | `75` | Приховати використання памʼяті, якщо не перевищено цей відсоток. |
| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Формат модуля. |
| `symbol` | `'🐏'` | Символ, який знаходиться перед значенням використання памʼяті. |
| `style` | `'bold dimmed white'` | Стиль модуля. |
| `disabled` | `true` | Вимикає модуль `memory_usage` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ---------------- | ------------- | ---------------------------------------- |
| ram | `31GiB/65GiB` | Використана/загальна памʼять. |
| ram_pct | `48%` | Відсоток завантаженості памʼяті системи. |
| swap\*\* | `1GiB/4GiB` | Розмір файлу підкачки. |
| swap_pct\*\* | `77%` | Процент завантаженості файлу підкачки. |
| symbol | `🐏` | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
*: Цю змінну можна використовувати лише як частину стилю рядка *\* : Інформація щодо файлів SWAP показується лише у разі наявності в поточній системі
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
2022-12-05 06:54:12 +00:00
symbol = ' '
style = 'bold dimmed green'
2022-10-15 01:53:32 +00:00
```
## Meson
2023-09-03 01:08:16 +00:00
Модуль `meson` показує поточний стан оточення розробки Meson.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Стандартно показується назва проєкту Meson, якщо встановлено `$MESON_DEVENV` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `2^32 - 1` | Скорочує назву проєкту до `N` графем. |
| `truncation_symbol` | `'…'` | Символ, що використовується для позначення назви проєкту, який було скорочено. Ви можете використовувати `''` , щоб нічого не показувати. |
| `format` | `'via [$symbol$project]($style) '` | Формат модуля. |
| `symbol` | `'⬢ '` | Символ, який знаходиться перед назвою проєкту. |
| `style` | `'blue bold'` | Стиль модуля. |
| `disabled` | `false` | Вимкнути модуль `meson` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ---------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| project | `starship` | Поточна назва проєкту з Meson |
2023-04-11 04:05:27 +00:00
| symbol | `🐏` | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[meson]
disabled = false
2022-12-05 06:54:12 +00:00
truncation_symbol = '--'
symbol = ' '
style = 'bold dimmed green'
2022-10-15 01:53:32 +00:00
```
## Mercurial Branch
2023-09-03 01:08:16 +00:00
Модуль `hg_branch` показує активну гілку та вершину репозиторію у вашій поточній теці.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------- |
| `symbol` | `' '` | Символ, що використовується перед закладкою hg чи назвою гілки у вашій поточній теці. |
| `style` | `'bold purple'` | Стиль модуля. |
| `format` | `'on [$symbol$branch(:$topic)]($style) '` | Формат модуля. |
| `truncation_length` | `2^63 - 1` | Скорочує назву гілки/вершини до `N` графем |
| `truncation_symbol` | `'…'` | Символ, що використовується для позначення назви гілки, яка була скорочена. |
| `disabled` | `true` | Вимикає модуль `hg_branch` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| branch | `master` | Поточна гілка mercurial |
| topic | `feature` | Поточна вершина mercurial |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[hg_branch]
2022-12-05 06:54:12 +00:00
format = 'on [🌱 $branch ](bold purple )'
2022-10-15 01:53:32 +00:00
truncation_length = 4
2022-12-05 06:54:12 +00:00
truncation_symbol = ''
2022-10-15 01:53:32 +00:00
```
## Nim
2023-09-03 01:08:16 +00:00
Модуль `nim` показує поточну встановлену версію [Nim ](https://nim-lang.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `nim.cfg`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли з розширенням `.nim`
- Поточна тека містить файли з розширенням `.nims`
- Поточна тека містить файли з розширенням `.nimble`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
2023-09-03 01:08:16 +00:00
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля |
2023-04-12 18:43:40 +00:00
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'👑 '` | Символ, який знаходиться перед версією Nim. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['nim', 'nims', 'nimble']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['nim.cfg']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'bold yellow'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `nim` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v1.2.0` | Версія `nimc` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[nim]
2022-12-05 06:54:12 +00:00
style = 'yellow'
symbol = '🎣 '
2022-10-15 01:53:32 +00:00
```
## Nix-shell
2023-09-03 01:08:16 +00:00
Модуль `nix_shell` показує середовище [nix-shell ](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html ). Модуль буде показано, коли ви перебуваєте в середовищі nix-shell.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------- | ---------------------------------------------- | -------------------------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | Формат модуля. |
| `symbol` | `'❄️ '` | Формат рядка, що представляє символ nix-shell. |
| `style` | `'bold blue'` | Стиль модуля. |
| `impure_msg` | `'impure'` | Формат рядка, який показується, коли оболонка (impure) нечиста. |
| `pure_msg` | `'pure'` | Формат рядка, який показується, коли оболонка (pure) чиста. |
| `unknown_msg` | `''` | Формат рядка, у випадку, коли стан невідомий. |
| `disabled` | `false` | Вимикає модуль `nix_shell` . |
| `heuristic` | `false` | Намагається визначити новий `nix shell` -стиль евристичними методами. |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| state | `pure` | Стан nix-shell |
| name | `lorri` | Назва nix-shell |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[nix_shell]
disabled = true
2022-12-05 06:54:12 +00:00
impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)'
2023-01-31 16:14:38 +00:00
unknown_msg = '[unknown shell](bold yellow)'
2022-10-15 01:53:32 +00:00
format = 'via [☃️ $state( \($name\)) ](bold blue ) '
```
## Node.js
2023-09-03 01:08:16 +00:00
Модуль `nodejs` показує поточну встановлену версію [Node.js ](https://nodejs.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `package.json`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.node-version`
- Поточна тека містить файл `.nvmrc`
- Поточна тека містить теку `node_modules`
- Поточна тека містить файли з розширеннями `.js` , `.mjs` а б о `.cjs`
- Поточна тека містить файли з розширеннями `.ts` , `.mts` чи `.cts`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------------ | -------------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
| `symbol` | `' '` | Формат рядка, що представляє символ 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` | Вимикає модуль `nodejs` . |
| `not_capable_style` | `bold red` | Стиль для модуля, коли версія рушія у package.json не відповідає версії Node.js. |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| version | `v13.12.0` | Версія `node` |
| engines_version | `>=12.0.0` | вимоги до версії `node` , як зазначено в описі `package.json` . Буде показано лише коли потрібна версія не збігається з версією `node` . |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[nodejs]
2022-12-05 06:54:12 +00:00
format = 'via [🤖 $version ](bold green ) '
2022-10-15 01:53:32 +00:00
```
## OCaml
2023-09-03 01:08:16 +00:00
Модуль `ocaml` показує поточну встановлену версію [OCaml ](https://ocaml.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли з розширенням `.opam` а б о теку `_opam`
- Поточна тека містить теку `esy.lock`
- Поточна тека містить файли `dune` а б о `dune-project`
- Поточна тека містить файли `jbuild` чи `jbuild-ignore`
- Поточна тека містить файл `.merlin`
- Поточна тека містить файли з розширеннями `.ml` , `.mli` , `.re` а б о `.rei`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | Формат рядка модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🐫 '` | Символ, який знаходиться перед версією OCaml. |
| `global_switch_indicator` | `''` | Формат рядка для глобального перемикача OPAM. |
| `local_switch_indicator` | `'*'` | Формат рядка для локального перемикача OPAM. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `['_opam', 'esy.lock']` | В яких теках цей модуль має запускатись. |
| `style` | `'bold yellow'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `ocaml` . |
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ---------------- | ------------ | --------------------------------------------------------------- |
| version | `v4.10.0` | Версія `ocaml` |
| switch_name | `my-project` | Поточний перемикач OPAM |
| switch_indicator | | Віддзеркалює значення `indicator` для поточного перемикача OPAM |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[ocaml]
2022-12-05 06:54:12 +00:00
format = 'via [🐪 $version ]($style ) '
```
## Open Policy Agent
2023-09-03 01:08:16 +00:00
Модуль `opa` показує поточну встановлену версію OPA. Стандартно модуль буде показаний, якщо поточна тека містить файли `.rego` .
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-12-05 06:54:12 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🪖 '` | Формат рядка, що представляє символ OPA. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['rego']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'bold blue'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `opa` . |
2022-12-05 06:54:12 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v0.44.0` | Версія `opa` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-12-05 06:54:12 +00:00
```toml
# ~/.config/starship.toml
[opa]
format = 'via [⛑️ $version ](bold red ) '
2022-10-15 01:53:32 +00:00
```
## OpenStack
2023-09-03 01:08:16 +00:00
Модуль `openstack` показує поточну хмару OpenStack і проєкт. Модуль активний лише тоді, коли встановлено змінну оточення `OS_CLOUD` , і в цьому випадку він читатиме файл `clouds.yaml` із будь-якого з [стандартного розташування ](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files ), щоб отримати поточний проєкт для використання.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------- | ----------------------------------------------- | ----------------------------------------------------------------------------- |
| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | Формат модуля. |
| `symbol` | `'☁️ '` | Символ, який використовується під час показу перед поточною хмарою OpenStack. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `openstack` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| cloud | `corp` | Поточна хмара OpenStack |
| project | `dev` | Поточний проєкт OpenStack |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[openstack]
format = 'on [$symbol$cloud(\($project\)) ]($style ) '
2022-12-05 06:54:12 +00:00
style = 'bold yellow'
symbol = '☁️ '
```
## OS
2023-09-03 01:08:16 +00:00
Модуль `os` показує поточну операційну систему. Інформація про О С отримується через [os_info ](https://lib.rs/crates/os_info ).
2022-12-05 06:54:12 +00:00
::: warning
2023-09-03 01:08:16 +00:00
[os_info ](https://lib.rs/crates/os_info ), що використовується в цьому модулі, може бути неточним для деяких систем.
2022-12-05 06:54:12 +00:00
:::
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-12-05 06:54:12 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-12-05 06:54:12 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------- | --------------------- | ------------------------------------------------ |
| `format` | `"[$symbol]($style)"` | Формат модуля. |
| `style` | `"bold white"` | Стиль модуля. |
| `disabled` | `true` | Вимикає модуль `os` . |
| `symbols` | | Таблиця символів для кожної операційної системи. |
2022-12-05 06:54:12 +00:00
2023-09-03 01:08:16 +00:00
`symbols` дозволяє визначити довільні символи для кожного типу операційної системи. Типи операційних систем не визначені вашою конфігурацією, використовують стандартну таблицю символів, дивись нижче. Н а цю мить у с і операційні системи, що підтримуються модулем, перераховані нижче. Якщо ви бажаєте додати операційну систему, то можете створити [запит на функцію ](https://github.com/starship/starship/issues/new/choose ).
2022-12-05 06:54:12 +00:00
```toml
2023-09-17 00:31:34 +00:00
# Це таблиця стандартних символів.
2022-12-05 06:54:12 +00:00
[os.symbols]
2023-04-11 04:05:27 +00:00
Alpaquita = "🔔 "
2022-12-05 06:54:12 +00:00
Alpine = "🏔️ "
Amazon = "🙂 "
Android = "🤖 "
Arch = "🎗️ "
2023-04-11 04:05:27 +00:00
Artix = "🎗️ "
2022-12-05 06:54:12 +00:00
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🦅 "
Gentoo = "🗜️ "
HardenedBSD = "🛡️ "
Illumos = "🐦 "
Linux = "🐧 "
2023-04-11 04:05:27 +00:00
Mabox = "📦 "
2022-12-05 06:54:12 +00:00
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄️ "
OpenBSD = "🐡 "
2023-02-21 03:40:15 +00:00
OpenCloudOS = "☁️ "
openEuler = "🦉 "
2022-12-05 06:54:12 +00:00
openSUSE = "🦎 "
OracleLinux = "🦴 "
Pop = "🍭 "
Raspbian = "🍓 "
Redhat = "🎩 "
RedHatEnterprise = "🎩 "
Redox = "🧪 "
Solus = "⛵ "
SUSE = "🦎 "
Ubuntu = "🎯 "
Unknown = "❓ "
Windows = "🪟 "
```
2023-04-12 18:43:40 +00:00
### Змінні
2022-12-05 06:54:12 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| --------- | ------------ | --------------------------------------------------------------------- |
| symbol | `🎗️` | Поточний символ операційної системи з розширеного параметра `symbols` |
| name | `Arch Linux` | Назва поточної операційної системи |
| type | `Arch` | Тип поточної операційної системи |
| codename | | Поточна кодова назва операційної системи, за наявності |
| edition | | Поточна редакція операційної системи, за наявності |
| version | | Поточна версія операційної системи, за наявності |
| style\* | | Віддзеркалює значення параметра `style` |
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-12-05 06:54:12 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-12-05 06:54:12 +00:00
```toml
# ~/.config/starship.toml
[os]
format = "on [($name ) ]($style )"
style = "bold blue"
disabled = false
[os.symbols]
Windows = " "
Arch = "Arch is the best! "
2022-10-15 01:53:32 +00:00
```
## Package Version
2023-09-03 01:08:16 +00:00
Модуль `package` показується, коли поточна тека є сховищем для пакунка, і показує його поточну версію. Наразі модуль підтримує такі пакунки: `npm` , `nimble` , `cargo` , `poetry` , `python` , `composer` , `gradle` , `julia` , `mix` , `helm` , `shards` , `daml` and `dart` .
2023-04-12 18:43:40 +00:00
- [**npm** ](https://docs.npmjs.com/cli/commands/npm ) — версія пакунка `npm` отримується з `package.json` з поточної теки
- [**Cargo** ](https://doc.rust-lang.org/cargo/ ) — версія пакунка `cargo` отримується з `Cargo.toml` з поточної теки
- [**Nimble** ](https://github.com/nim-lang/nimble ) — версія пакунка `nimble` з файлу `*.nimble` з поточної теки, отримана командою `nimble dump`
- [**Poetry** ](https://python-poetry.org/ ) — версія пакунка `poetry` отримується з `pyproject.toml` з поточної теки
- [**Python** ](https://www.python.org ) — версія пакунка `python` отримана із [PEP 621 ](https://peps.python.org/pep-0621/ ) сумісних файлів `pyproject.toml` чи `setup.cfg` у поточній теці
- [**Composer** ](https://getcomposer.org/ ) — версія пакунка `composer` отримується з `composer.json` з поточної теки
- [**Gradle** ](https://gradle.org/ ) — версія пакунка `gradle` отримується з `build.gradle` з поточної теки
- [**Julia** ](https://docs.julialang.org/en/v1/stdlib/Pkg/ ) — версія пакунка отримується з `Project.toml` з поточної теки
- [**Mix** ](https://hexdocs.pm/mix/ ) — версія пакунка `mix` отримується з `mix.exs` з поточної теки
- [**Helm** ](https://helm.sh/docs/helm/helm_package/ ) — версія чарту `helm` отримується з `Chart.yaml` з поточної теки
- [**Maven** ](https://maven.apache.org/ ) — версія пакунка `maven` отримується з `pom.xml` з поточної теки
- [**Meson** ](https://mesonbuild.com/ ) — версія пакунка `meson` отримується з `meson.build` з поточної теки
- [**Shards** ](https://crystal-lang.org/reference/the_shards_command/index.html ) — версія пакунка `shards` отримується з `shard.yml` з поточної теки
- [**V** ](https://vlang.io ) — версія пакунка `vlang` отримується з `v.mod` з поточної теки
- [**SBT** ](https://scala-sbt.org ) — версія пакунка `sbt` отримується з `build.sbt` з поточної теки
- [**Daml** ](https://www.digitalasset.com/developers ) — версія пакунка `daml` отримується з `daml.yaml` з поточної теки
- [**Dart** ](https://pub.dev/ ) — версія пакунка `dart` отримується з `pubspec.yaml` з поточної теки
> ⚠️ Показується версія пакунка, сирці якого знаходяться у вашій поточній теці, а не у вашому менеджері пакунків.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ----------------- | --------------------------------- | ----------------------------------------------------------------- |
| `format` | `'is [$symbol$version]($style) '` | Формат модуля. |
2023-09-03 01:08:16 +00:00
| `symbol` | `'📦 '` | Символ, який знаходиться перед версією пакунка. |
2023-04-12 18:43:40 +00:00
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
| `style` | `'bold 208'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `display_private` | `false` | Вмикає показ версій для приватних пакунків. |
| `disabled` | `false` | Вимикає модуль `package` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v1.0.0` | Версія вашого пакунка |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[package]
2022-12-05 06:54:12 +00:00
format = 'via [🎁 $version ](208 bold ) '
2022-10-15 01:53:32 +00:00
```
## Perl
2023-09-03 01:08:16 +00:00
Модуль `perl` показує поточну встановлену версію [Perl ](https://www.perl.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли `Makefile.PL` чи `Build.PL`
- Поточна тека містить файли `cpanfile` а б о `cpanfile.snapshot`
- Поточна тека містить файли, `META.json` а б о `META.yml`
- Поточна тека містить файл `.perl-version`
- Поточна тека містить файли `.pl` , `.pm` а б о `.pod`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат рядка модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🐪 '` | Символ, який знаходиться перед версією Perl |
2023-04-12 18:43:40 +00:00
| `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'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `perl` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | --------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v5.26.1` | Версія `perl` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[perl]
2022-12-05 06:54:12 +00:00
format = 'via [🦪 $version ]($style ) '
2022-10-15 01:53:32 +00:00
```
## PHP
2023-09-03 01:08:16 +00:00
Модуль `php` показує поточну встановлену версію [PHP ](https://www.php.net/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `composer.json`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.php-version`
- Поточна тека містить файл `.php`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🐘 '` | Символ, який знаходиться перед версією PHP. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['php']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['composer.json', '.php-version']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'147 bold'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `php` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v7.3.8` | Версія `php` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[php]
2022-12-05 06:54:12 +00:00
format = 'via [🔹 $version ](147 bold ) '
2022-10-15 01:53:32 +00:00
```
2023-01-31 16:14:38 +00:00
## Pijul Channel
2023-09-03 01:08:16 +00:00
Модуль `pijul_channel` показує активний канал репозиторію у вашій поточній теці.
2023-01-31 16:14:38 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2023-01-31 16:14:38 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | --------------------------------- | --------------------------------------------------------------------------- |
| `symbol` | `' '` | Символ, що використовується перед каналом pijul у вашій поточній теці. |
| `style` | `'bold purple'` | Стиль модуля. |
| `format` | `'on [$symbol$channel]($style) '` | Формат модуля. |
| `truncation_length` | `2^63 - 1` | Скорочує назву каналу pijul до `N` графем |
| `truncation_symbol` | `'…'` | Символ, що використовується для позначення назви гілки, яка була скорочена. |
| `disabled` | `true` | Вимикає модуль `pijul` . |
2023-01-31 16:14:38 +00:00
2022-10-15 01:53:32 +00:00
## Pulumi
2023-09-03 01:08:16 +00:00
Модуль `pulumi` показує імʼя поточного користувача та версію обраного [Pulumi Stack ](https://www.pulumi.com/docs/intro/concepts/stack/ ).
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням, версія Pulumi не показана, тому що отримання версії потребує на порядок більше часу, ніж потрібно іншим плагінам (близько 70мc). Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче ](#with-pulumi-version ).
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- У поточній теці є а б о `Pulumi.yaml` а б о `Pulumi.yml`
- Батьківська тека містить а б о `Pulumi.yaml` а б о `Pulumi.yml` , якщо для `search_upwards` не встановлено значення `false`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ---------------- | -------------------------------------------- | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($username@)$stack]($style) '` | Формат рядка модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `' '` | Формат рядка перед стеком Pulumi. |
2023-04-12 18:43:40 +00:00
| `style` | `'bold 5'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `search_upwards` | `true` | Дозволяє шукати файли налаштування pulumi у батьківських теках. |
| `disabled` | `false` | Вимикає модуль `pulumi` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ---------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v0.12.24` | Версія `pulumi` |
| stack | `dev` | Поточний стек Pulumi |
| username | `alice` | Поточне імʼя користувача Pulumi |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
2023-09-17 00:31:34 +00:00
#### З версією Pulumi
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[pulumi]
2022-12-05 06:54:12 +00:00
format = '[🛥 ($version )$stack]($style) '
2022-10-15 01:53:32 +00:00
```
2023-09-17 00:31:34 +00:00
#### Без версії Pulumi
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[pulumi]
2022-12-05 06:54:12 +00:00
symbol = '🛥 '
format = '[$symbol$stack]($style) '
2022-10-15 01:53:32 +00:00
```
## PureScript
2023-09-03 01:08:16 +00:00
Модуль `purescript` показує поточну встановлену версію [PureScript ](https://www.purescript.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `spago.dhall`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли з розширенням `.purs`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'<=> '` | Символ, який знаходиться перед версією PureScript. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['purs']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['spago.dhall']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'bold white'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `purescript` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `0.13.5` | Версія `purescript` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[purescript]
2022-12-05 06:54:12 +00:00
format = 'via [$symbol$version ](bold white )'
2022-10-15 01:53:32 +00:00
```
## Python
2023-09-03 01:08:16 +00:00
Модуль `python` показує поточну встановлену версію [Python ](https://www.python.org/ ) і поточне [віртуальне середовище Python ](https://docs.python.org/tutorial/venv.html ), якщо воно активоване.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Якщо `pyenv_version_name` має значення `true` , показуватиметься назва версії pyenv. В іншому випадку буде показано номер версії з `python --version` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.python-version`
- Поточна тека містить файл `Pipfile`
- Поточна тека містить файл `__init__.py`
2023-04-11 04:05:27 +00:00
- Поточна тека містить файл `pyproject.toml`
- Поточна тека містить файл `requirements.txt`
- Поточна тека містить файл `setup.py`
- Поточна тека містить файл `tox.ini`
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.py` .
- Віртуальне середовище активовано
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
| `symbol` | `'🐍 '` | Формат рядка, що представляє символ Python |
| `style` | `'yellow bold'` | Стиль модуля. |
| `pyenv_version_name` | `false` | Використовувати pyenv для отримання версії Python |
| `pyenv_prefix` | `pyenv` | Префікс перед версією pyenv, показується якщо pyenv використовується |
| `python_binary` | `['python', 'python3', 'python2']` | Налаштовує бінарні файли python, який Starship буде використовувати для отримання версії. |
| `detect_extensions` | `['py']` | Які розширення повинні запускати цей модуль |
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Назви файлів, які активують модуль |
| `detect_folders` | `[]` | Назви тек, що активують модуль |
| `disabled` | `false` | Вимикає модуль `python` . |
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
Змінна `python_binary` приймає як рядок, так список рядків. Starship спробує запустити кожен бінарний файл, поки це не дасть результат. Зауважте, що можна змінити двійковий файл, який використовується Starship, щоб отримати версію Python, а не параметрів, які використовуються.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Стандартні значення та порядок для `python_binary` було вибрано так, щоб спочатку ідентифікувати версію Python у середовищах virtualenv/conda (які наразі все ще додають `python` , незалежно від того, чи вказує він на `python3` чи на `python2` ). Це може мати побічний ефект: якщо у вас все ще встановлено системний Python 2, він може бути обраний перед будь-яким Python 3 (принаймні в дистрибутивах Linux, які завжди містять символічне посилання `/usr/bin/python` на Python 2). Якщо ви більше не працюєте з Python 2, але не можете видалити системний Python 2, змінивши його на `'python3'` , ви приховаєте будь-яку версію Python 2, див. приклад нижче.
2022-10-15 01:53:32 +00:00
:::
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ------------ | --------------- | ---------------------------------------------- |
| version | `'v3.8.1'` | Версія `python` |
| symbol | `'🐍 '` | Віддзеркалює значення параметра `symbol` |
| style | `'yellow bold'` | Віддзеркалює значення параметра `style` |
| pyenv_prefix | `'pyenv '` | Віддзеркалює значення параметра `pyenv_prefix` |
| virtualenv | `'venv'` | Назва `virtualenv` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[python]
2022-12-05 06:54:12 +00:00
symbol = '👾 '
2022-10-15 01:53:32 +00:00
pyenv_version_name = true
```
```toml
# ~/.config/starship.toml
[python]
2023-09-17 19:40:06 +00:00
# Використання лише `python3` для отримання версії.
2022-12-05 06:54:12 +00:00
python_binary = 'python3'
2022-10-15 01:53:32 +00:00
```
```toml
# ~/.config/starship.toml
[python]
2023-09-17 00:31:34 +00:00
# Н е запускати файли з розширенням py
2022-10-15 01:53:32 +00:00
detect_extensions = []
```
```toml
# ~/.config/starship.toml
[python]
2023-09-17 00:31:34 +00:00
# Показувати версію python з venv.
2022-10-15 01:53:32 +00:00
#
2023-09-17 00:31:34 +00:00
# Зауважте, що це працюватиме лише тоді, коли venv знаходиться всередині проєкту, і він працюватиме
# лише в теці, яка містить теку venv, якщо це нормально?
2022-12-05 06:54:12 +00:00
python_binary = ['./venv/bin/python', 'python', 'python3', 'python2']
2022-10-15 01:53:32 +00:00
```
## R
2023-09-03 01:08:16 +00:00
Модуль `rlang` показує поточну встановлену версію [R ](https://www.r-project.org/ ). Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли з розширенням `.R` .
- Поточна тека містить файли з розширенням `.Rd` .
- Поточна тека містить файли з розширенням `.Rmd` .
- Поточна тека містить файли з розширенням `.Rproj` .
- Поточна тека містить файли з розширенням `.Rsx` .
- Поточна тека містить файл `.Rprofile`
- Поточна тека містить файл `.Rproj.user`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'📐'` | Формат рядка, що представляє символ R. |
2023-04-12 18:43:40 +00:00
| `style` | `'blue bold'` | Стиль модуля. |
| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Які розширення повинні запускати цей модуль |
| `detect_files` | `['.Rprofile']` | Назви файлів, які активують модуль |
| `detect_folders` | `['.Rproj.user']` | Назви тек, що активують модуль |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `r` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| ------- | ------------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v4.0.5` | Версія `R` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style | `'blue bold'` | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[rlang]
2022-12-05 06:54:12 +00:00
format = 'with [📐 $version ](blue bold ) '
2022-10-15 01:53:32 +00:00
```
## Raku
2023-09-03 01:08:16 +00:00
Модуль `raku` показує поточну встановлену версію [Raku ](https://www.raku.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `META6.json`
- Поточна тека містить файли `.p6` , `.pm6` , `.raku` , `.rakumod` а б о `.pod6`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version-$vm_version )]($style)'` | Формат рядка модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🦋 '` | Символ, який знаходиться перед версією Raku |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['META6.json']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'bold 149'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `raku` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| ---------- | ------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v6.d` | Версія `raku` |
| vm_version | `moar` | Версія VM `raku` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[raku]
2022-12-05 06:54:12 +00:00
format = 'via [🦪 $version ]($style ) '
2022-10-15 01:53:32 +00:00
```
## Red
2023-09-03 01:08:16 +00:00
Модуль `red` показує поточну встановлену версію [Red ](https://www.red-lang.org/ ). Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли `.red` а б о `.reds`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🔺 '` | Формат рядка, що представляє символ Red. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['red']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'red bold'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `red` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v2.5.1` | Версія `red` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[red]
2022-12-05 06:54:12 +00:00
symbol = '🔴 '
2022-10-15 01:53:32 +00:00
```
## Ruby
2023-09-03 01:08:16 +00:00
Модуль `ruby` показує поточну встановлену версію [Ruby ](https://www.ruby-lang.org/ ). Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `Gemfile`
- Поточна тека містить файл `.ruby-version`
- Поточна тека містить файл `.rb`
- Встановлено змінні середовища `RUBY_VERSION` а б о `RBENV_VERSION`
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Starship отримує поточну версію Ruby командою `ruby -v` .
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'💎 '` | Формат рядка, що представляє символ Ruby. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['rb']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['Gemfile', '.ruby-version']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
2023-09-03 01:08:16 +00:00
| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Які змінні середовища повинні запускати цей модуль. |
2023-04-12 18:43:40 +00:00
| `style` | `'bold red'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `ruby` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v2.5.1` | Версія `ruby` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[ruby]
2022-12-05 06:54:12 +00:00
symbol = '🔺 '
2022-10-15 01:53:32 +00:00
```
## Rust
2023-09-03 01:08:16 +00:00
Модуль `rust` показує поточну встановлену версію [Rust ](https://www.rust-lang.org/ ). Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `Cargo.toml`
- Поточна тека містить файли з розширенням `.rs`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🦀 '` | Формат рядка, що представляє символ Rust |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['rs']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['Cargo.toml']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'bold red'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `rust` . |
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| --------- | ----------------- | ---------------------------------------- |
| version | `v1.43.0-nightly` | Версія `rustc` |
| numver | `1.51.0` | Числовий компонент версії `rustc` |
| toolchain | `beta` | Версія toolchain |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[rust]
2022-12-05 06:54:12 +00:00
format = 'via [⚙️ $version ](red bold )'
2022-10-15 01:53:32 +00:00
```
## Scala
2023-09-03 01:08:16 +00:00
Модуль `scala` показує поточну встановлену версію [Scala ](https://www.scala-lang.org/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли `build.sbt` , `.scalaenv` а б о `.sbtenv`
- Поточна тека містить файли `.scala` а б о `.sbt`
- В поточній теці є тека `.metals`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ---------------------------------------- | ----------------------------------------------------------------- |
| `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']` | Які теки мають запускати цей модуль. |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🆂 '` | Формат рядка, що представляє символ Scala. |
2023-04-12 18:43:40 +00:00
| `style` | `'red dimmed'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `scala` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `2.13.5` | Версія `scala` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[scala]
2022-12-05 06:54:12 +00:00
symbol = '🌟 '
2022-10-15 01:53:32 +00:00
```
## Shell
2023-09-03 01:08:16 +00:00
Модуль `shell` показує індикатор поточної оболонки.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------------------- | ------------------------- | -------------------------------------------------------------- |
| `bash_indicator` | `'bsh'` | Формат рядка, що використовується для bash. |
| `fish_indicator` | `'fsh'` | Формат рядка, що використовується для fish. |
| `zsh_indicator` | `'zsh'` | Формат рядка, що використовується для zsh. |
| `powershell_indicator` | `'psh'` | Формат рядка, що використовується для powershell. |
| `ion_indicator` | `'ion'` | Формат рядка, що використовується для ion. |
| `elvish_indicator` | `'esh'` | Формат рядка, що використовується для elvish. |
| `tcsh_indicator` | `'tsh'` | Формат рядка, що використовується для tcsh. |
| `xonsh_indicator` | `'xsh'` | Формат рядка, що використовується для xonsh. |
| `cmd_indicator` | `'cmd'` | Формат рядка, що використовується для cmd. |
| `nu_indicator` | `'nu'` | Формат рядка, що використовується для nu. |
| `unknown_indicator` | `''` | Типове значення, що буде показане, якщо оболонка не визначена. |
| `format` | `'[$indicator]($style) '` | Формат модуля. |
| `style` | `'white bold'` | Стиль модуля. |
| `disabled` | `true` | Вимикає модуль `shell` . |
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Стандартно | Опис |
| --------- | ---------- | -------------------------------------------------------- |
| indicator | | Віддзеркалює значення `indicator` для поточної оболонки. |
| style\* | | Віддзеркалює значення параметра `style` . |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклади
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[shell]
2023-06-06 14:10:23 +00:00
fish_indicator = ' '
2022-12-05 06:54:12 +00:00
powershell_indicator = '_'
unknown_indicator = 'mystery shell'
style = 'cyan bold'
2022-10-15 01:53:32 +00:00
disabled = false
```
## SHLVL
2023-09-03 01:08:16 +00:00
Модуль `shlvl` показує поточний [`SHLVL` ](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF ) ('shell level') змінну оточення, якщо він встановлений на число і збігається а б о перевищує вказаний поріг.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| --------------- | ---------------------------- | ---------------------------------------------------------------------------------- |
| `threshold` | `2` | Граничне значення для показу. |
| `format` | `'[$symbol$shlvl]($style) '` | Формат модуля. |
| `symbol` | `'↕️ '` | Символ, який використовується для показу `SHLVL` . |
| `repeat` | `false` | Повторно показує `symbol` в кількості зазначеній у `SHLVL` . |
| `repeat_offset` | `0` | Зменшує кількість разів, коли `symbol` повторюється використовуючи значення offset |
| `style` | `'bold yellow'` | Стиль модуля. |
| `disabled` | `true` | Вимикає модуль `shlvl` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| shlvl | `3` | Поточне значення `SHLVL` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
2022-12-05 06:54:12 +00:00
format = '$shlvl level(s) down'
2022-10-15 01:53:32 +00:00
threshold = 3
```
2023-09-03 01:08:16 +00:00
Використовуючи `repeat` та `repeat_offset` разом з модулем `character` , ви можете отримати рядок виду `❯ ❯ ❯ ` , де останній символ має колір відповідно до статусу виконання останньої команди, а символи, що йому передують зазначаються у `shlvl` .
docs(i18n): new Crowdin updates (#5237)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Russian)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Norwegian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Japanese)
* New translations README.md (Polish)
* New translations README.md (Spanish)
* New translations README.md (Japanese)
* New translations README.md (Polish)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Ukrainian)
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (French)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Vietnamese)
* New translations README.md (Vietnamese)
* New translations README.md (Vietnamese)
* New translations README.md (French)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Arabic)
* New translations README.md (Polish)
* New translations README.md (Spanish)
* New translations README.md (French)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Russian)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Spanish)
* New translations README.md (French)
* New translations README.md (German)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Ukrainian)
* New translations README.md (Ukrainian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Spanish)
* New translations README.md (French)
* New translations README.md (Arabic)
* New translations README.md (German)
* New translations README.md (Italian)
* New translations README.md (Japanese)
* New translations README.md (Korean)
* New translations README.md (Dutch)
* New translations README.md (Polish)
* New translations README.md (Portuguese)
* New translations README.md (Russian)
* New translations README.md (Turkish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Vietnamese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Indonesian)
* New translations README.md (Sorani (Kurdish))
* New translations README.md (Ukrainian)
* New translations README.md (Norwegian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Ukrainian)
2023-07-30 13:29:01 +00:00
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = '[$symbol$shlvl]($style)'
repeat = true
symbol = '❯ '
repeat_offset = 1
threshold = 0
```
2022-10-15 01:53:32 +00:00
## Singularity
2023-09-03 01:08:16 +00:00
Модуль `singularity` показує поточний образ [Singularity ](https://sylabs.io/singularity/ ), якщо ви всередині контейнера і `$SINGULARITY_NAME` встановлено.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------- | -------------------------------- | ------------------------------------------------- |
| `format` | `'[$symbol\[$env\]]($style) '` | Формат модуля. |
| `symbol` | `''` | Формат рядка, що показується перед назвою образу. |
| `style` | `'bold dimmed blue'` | Стиль модуля. |
| `disabled` | `false` | Вимикає модуль `singularity` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------------ | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| env | `centos.img` | Поточний образ Singularity |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
```
2023-06-06 14:10:23 +00:00
## Solidity
2023-09-03 01:08:16 +00:00
Модуль `solidity` показує поточну версію [Solidity ](https://soliditylang.org/ ) Модуль буде показано, якщо буде вказано якісь з наступних умов:
2023-06-06 14:10:23 +00:00
- Поточна тека містить файл `.sol`
### Параметри
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${major}.${minor}.${patch}"` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `"S "` | Формат рядка, що представляє символ Solidity |
| `compiler | ["solc"] | Стандартний компілятор Solidity. |
2023-06-06 14:10:23 +00:00
| `detect_extensions` | `["sol"]` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `"bold blue"` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вмикає цей модуль. |
2023-06-06 14:10:23 +00:00
### Змінні
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v0.8.1` | Версія `solidity` |
2023-06-06 14:10:23 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
*: Ця змінна може бути використана лише як частина стилю рядка
### Приклад
```toml
# ~/.config/starship.toml
[solidity]
format = "via [S $version ](blue bold )"
```
2022-10-15 01:53:32 +00:00
## Spack
2023-09-03 01:08:16 +00:00
Модуль `spack` показує інформацію про поточне оточення [Spack ](https://spack.readthedocs.io/en/latest/ ), якщо змінна `$SPACK_ENV` встановлена.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | Кількість тек, до яких має бути скорочений шлях до середовища оточення. `0` – означає без скорочення. Також подивіться модуль [`directory` ](#directory ). |
| `symbol` | `'🅢 '` | Символ що передує назві оточення. |
| `style` | `'bold blue'` | Стиль модуля. |
| `format` | `'via [$symbol$environment]($style) '` | Формат модуля. |
| `disabled` | `false` | Вимикає модуль `spack` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| ----------- | ------------ | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| environment | `astronauts` | Поточне середовище spack |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[spack]
2022-12-05 06:54:12 +00:00
format = '[$symbol$environment](dimmed blue) '
2022-10-15 01:53:32 +00:00
```
## Status
2023-09-03 01:08:16 +00:00
Модуль `status` показує код завершення роботи попередньої команди. Якщо $success_symbol пустий (типово), модуль буде показаний тільки якщо код виходу не `0` . Код status буде перетворений у 32-бітне ціле число.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| --------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `format` | `'[$symbol$status]($style) '` | Формат модуля |
| `symbol` | `'❌'` | Символ, що показується у випадку помилки |
| `success_symbol` | `''` | Символ, що показується після успішного завершення попередньої команди |
| `not_executable_symbol` | `'🚫'` | Символ, що показується у випадку виконати файл, який не є виконуваним |
| `not_found_symbol` | `'🔍'` | Символ, що показується, коли команду не знайдено |
| `sigint_symbol` | `'🧱'` | Символ, що показується для SIGINT (Ctrl + c) |
| `signal_symbol` | `'⚡'` | Символ для будь-якого сигналу |
| `style` | `'bold red'` | Стиль модуля. |
| `recognize_signal_code` | `true` | Вмикає сигнал на код виходу |
| `map_symbol` | `false` | Вмикає символ на код виходу |
| `pipestatus` | `false` | Вмикає звітування про pipestatus |
| `pipestatus_separator` | < code > | </ code > | Символ, що використовується для розділення сегментів конвеєра (підтримує форматування) |
| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | Формат модуля, коли команда є конвеєром |
| `pipestatus_segment_format` | | Якщо вказано, замінює `format` під час форматування сегментів конвеєра |
| `disabled` | `true` | Вимикає модуль `status` . |
2023-04-12 18:43:40 +00:00
### Змінні
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| -------------- | ------- | -------------------------------------------------------------------------------- |
| status | `127` | Код виходу останньої команди |
| hex_status | `0x7F` | Код виходу останньої команди в hex |
| int | `127` | Код виходу останньої команди |
| common_meaning | `ERROR` | Значення коду, якщо не сигнал |
| signal_number | `9` | Номер сигналу, що відповідає коду завершення, за наявності |
| signal_name | `KILL` | Назва сигналу, що відповідає коду виходу лише в тому випадку, якщо його записано |
| maybe_int | `7` | Містить номер коду виходу, коли значення не знайдено |
| pipestatus | | Показує коду виходу конвеєра, доступно тільки в форматі pipestatus_format |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[status]
2022-12-05 06:54:12 +00:00
style = 'bg:blue'
symbol = '🔴 '
success_symbol = '🟢 SUCCESS'
2022-10-15 01:53:32 +00:00
format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
```
## Sudo
2023-09-03 01:08:16 +00:00
Модуль `sudo` показує, чи облікові дані sudo зараз є в кеші. Модуль показується лише за наявності даних в кеші.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| --------------- | ------------------------ | ----------------------------------------------------------------- |
| `format` | `'[as $symbol]($style)'` | Формат модуля |
| `symbol` | `'🧙 '` | Символ, що показується, коли облікові дані є в кеші |
| `style` | `'bold blue'` | Стиль модуля. |
| `allow_windows` | `false` | Оскільки Windows не має sudo, для цієї О с модуль типово вимкнено. |
| `disabled` | `true` | Вимикає модуль `sudo` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[sudo]
2022-12-05 06:54:12 +00:00
style = 'bold green'
symbol = '👩💻 '
2022-10-15 01:53:32 +00:00
disabled = false
```
```toml
# On windows
# $HOME\.starship\config.toml
[sudo]
allow_windows = true
disabled = false
```
## Swift
2023-09-03 01:08:16 +00:00
Модуль `swift` показує поточну встановлену версію [Swift ](https://swift.org/ ). Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `Package.swift`
- Поточна тека містить файли з розширенням `.swift`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'🐦 '` | Формат рядка, що представляє символ Swift |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['swift']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['Package.swift']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'bold 202'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `swift` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v5.2.4` | Версія `swift` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[swift]
2022-12-05 06:54:12 +00:00
format = 'via [🏎 $version ](red bold )'
2022-10-15 01:53:32 +00:00
```
## Terraform
2023-09-03 01:08:16 +00:00
Модуль `terraform` показує поточну вибрану [робочу область Terraform ](https://www.terraform.io/docs/language/state/workspaces.html ) і версію.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
Стандартно версія Terraform не показується, оскільки це повільно для поточних версій Terraform, особливо коли використовується багато втулків. Якщо ви все ще хочете увімкнути показ версії, [дивіться приклад нижче ](#with-terraform-version ).
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.terraform`
- Поточна тека містить файли з розширеннями`.tf`, `.tfplan` а б о `.tfstate`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol$workspace]($style) '` | Формат рядка модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'💠'` | Формат рядка, що відображається перед робочою областю terraform. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `['.terraform']` | В яких теках цей модуль має запускатись. |
| `style` | `'bold 105'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `terraform` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Змінна | Приклад | Опис |
| --------- | ---------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v0.12.24` | Версія `terraform` |
| workspace | `default` | Поточна робоча область Terraform |
2023-04-12 18:43:40 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
2023-09-17 00:31:34 +00:00
#### З а версією Terraform
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[terraform]
2022-12-05 06:54:12 +00:00
format = '[🏎💨 $version$workspace]($style) '
2022-10-15 01:53:32 +00:00
```
2023-09-17 00:31:34 +00:00
#### Без версії Terraform
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[terraform]
2022-12-05 06:54:12 +00:00
format = '[🏎💨 $workspace]($style) '
2022-10-15 01:53:32 +00:00
```
## Time
2023-09-03 01:08:16 +00:00
Модуль `time` показує поточний **місцевий** час. Значення `format` використовується крейтом [`chrono` ](https://crates.io/crates/chrono ) для визначення формату показу часу. Перегляньте [документацію chrono strftime ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ), щоб побачити, які параметри доступні.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
З а замовчуванням цей модуль вимкнутий. Щоб його увімкнути, встановіть значення параметра `disabled` в `false` у вашому файлі налаштувань.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `format` | `'at [$time]($style) '` | Формат рядка модуля. |
| `use_12hr` | `false` | Вмикає 12-годинний формат |
| `time_format` | дивіться нижче | Формат [chrono ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ) використовується для форматування часу. |
| `style` | `'bold yellow'` | Стиль модуля time |
| `utc_time_offset` | `'local'` | Встановлює зсув від UTC. Діапазон від -24 < x < 24. Дозволяє часові пояси із сувом 30/45 хвилин. |
| `disabled` | `true` | Вимикає модуль `time` . |
| `time_range` | `'-'` | Встановлює діапазон часу, протягом якого модуль показується. Час має бути зазначений у 24-годинному форматі |
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Якщо `use_12hr` є `true` , то стандартно `time_format` — `'%r'` . В іншому випадку стандартне значення — `'%T'` . Налаштований вручну `time_format` має перевагу над параметром `use_12hr` .
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ---------- | --------------------------------------- |
2023-09-03 01:08:16 +00:00
| time | `13:08:10` | Поточний час. |
2023-04-11 04:05:27 +00:00
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
2022-12-05 06:54:12 +00:00
time_format = '%T'
utc_time_offset = '-5'
time_range = '10:00:00-14:00:00'
2022-10-15 01:53:32 +00:00
```
## Username
2023-09-03 01:08:16 +00:00
Модуль `username` показує імʼя активного користувача. Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточний користувач має права суперкористувача
- Поточний користувач не є таким же, як той, який увійшов до системи
- Користувач зараз підключений через SSH
- Змінна `show_always` встановлена в true
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
Модуль виявляє підключення SSH перевіряючи змінні середовища `SSH_CONNECTION` , `SSH_CLIENT` і `SSH_TTY` . Якщо ваш хост SSH не налаштував ці змінні, одним зі способів розвʼязання проблеми є встановлення для однієї з них фіктивного значення.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------- | ----------------------- | ---------------------------------------------------------- |
| `style_root` | `'bold red'` | Стиль, який використовується коли користувач є root/admin. |
| `style_user` | `'bold yellow'` | Стиль для звичайних користувачів. |
| `format` | `'[$user]($style) in '` | Формат модуля. |
| `show_always` | `false` | Завжди показувати модуль `username` . |
| `disabled` | `false` | Вимикає модуль `username` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| ------- | ------------ | --------------------------------------------------------------------------------------------------- |
| `style` | `'red bold'` | Віддзеркалює значення параметра `style_root` коли користувач root, і `style_user` в іншому випадку. |
| `user` | `'matchai'` | Поточний користувач. |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[username]
2022-12-05 06:54:12 +00:00
style_user = 'white bold'
style_root = 'black bold'
format = 'user: [$user ]($style ) '
2022-10-15 01:53:32 +00:00
disabled = false
show_always = true
```
## Vagrant
2023-09-03 01:08:16 +00:00
Модуль `vagrant` показує поточну встановлену версію [Vagrant ](https://www.vagrantup.com/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `Vagrantfile`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'⍱ '` | Формат рядка, що представляє символ Vagrant. |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `[]` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['Vagrantfile']` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'cyan bold'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `vagrant` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ---------------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `Vagrant 2.2.10` | Версія `Vagrant` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[vagrant]
2022-12-05 06:54:12 +00:00
format = 'via [⍱ $version ](bold white ) '
2022-10-15 01:53:32 +00:00
```
## V
2023-09-03 01:08:16 +00:00
Модуль `vlang` показує поточну встановлену версію [V ](https://vlang.io/ ). Типово, модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файли з розширенням `.v`
- Поточна тека містить файли `v.mod` , `vpkg.json` а б о `.vpkg-lock.json`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | -------------------------------------------- | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'V '` | Формат рядка, що представляє символ V |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['v']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
| `style` | `'blue bold'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `vlang` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | ------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v0.2` | Версія `v` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[vlang]
2022-12-05 06:54:12 +00:00
format = 'via [V $version ](blue bold ) '
2022-10-15 01:53:32 +00:00
```
## VCSH
2023-09-03 01:08:16 +00:00
Модуль `vcsh` показує поточний репозиторій [VCSH ](https://github.com/RichiH/vcsh ). Модуль показується лише в тому випадку, якщо репозиторій використовується.
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ---------- | -------------------------------- | -------------------------------------------------- |
| `symbol` | `''` | Символ, який знаходиться перед назвою репозиторію. |
| `style` | `'bold yellow'` | Стиль модуля. |
| `format` | `'vcsh [$symbol$repo]($style) '` | Формат модуля. |
| `disabled` | `false` | Вимикає модуль `vcsh` . |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Змінна | Приклад | Опис |
| --------- | --------------------------------------------- | ---------------------------------------- |
| repo | `dotfiles` якщо в VCSH repo з іменем dotfiles | Назва поточного репозиторію |
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | `black bold dimmed` | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[vcsh]
2022-12-05 06:54:12 +00:00
format = '[🆅 $repo](bold blue) '
2022-10-15 01:53:32 +00:00
```
## Zig
2023-09-03 01:08:16 +00:00
Модуль `zig` показує поточну встановлену версію [Zig ](https://ziglang.org/ ). Модуль показується, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл `.zig`
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------- |
| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. |
| `version_format` | `'v${raw}'` | Формат версії. Доступні змінні `raw` , `major` , `minor` та `patch` |
2023-09-03 01:08:16 +00:00
| `symbol` | `'↯ '` | Символ, який знаходиться перед версією Zig. |
2023-04-12 18:43:40 +00:00
| `style` | `'bold yellow'` | Стиль модуля. |
2023-09-03 01:08:16 +00:00
| `disabled` | `false` | Вимикає модуль `zig` . |
2023-04-12 18:43:40 +00:00
| `detect_extensions` | `['zig']` | Які розширення повинні запускати цей модуль. |
| `detect_files` | `[]` | Які імена файлів мають запускати цей модуль. |
| `detect_folders` | `[]` | В яких теках цей модуль має запускатись. |
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Приклад | Опис |
| --------- | -------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| version | `v0.6.0` | Версія `zig` |
2023-04-11 04:05:27 +00:00
| symbol | | Віддзеркалює значення параметра `symbol` |
| style\* | | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[zig]
2022-12-05 06:54:12 +00:00
symbol = '⚡️ '
2022-10-15 01:53:32 +00:00
```
2023-09-03 01:08:16 +00:00
## Власні команди
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Модулі `custom` показують результат виконання певних довільних команд.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Модулі показуються, якщо виконується будь-яка з наступних умов:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Поточна тека містить файл, ім'я якого є в `detect_files`
- Поточна тека містить теки, ім'я яких вказано в `detect_folders`
- Поточна тека містить файл, розширення якого є в `detect_extensions`
- Команда `when` повертає 0
- Поточна операційна система (std::env::consts::OS) збігається з полем `os` , якщо визначено.
2022-10-15 01:53:32 +00:00
::: tip
2023-09-03 01:08:16 +00:00
Кілька власних модулів можна визначити за допомогою символу "`.`".
2022-10-15 01:53:32 +00:00
:::
::: tip
2023-09-03 01:08:16 +00:00
Порядок в якому власні модулі будуть показуватись може бути встановлений індивідуально додаванням `${custom.foo}` до змінної `format` верхнього рівня (через те, що назви містять точки вам треба використовувати`${...}`). Типово, модуль `custom` покаже у с і модулі custom, в тому порядку, в якому вони були визначені.
2022-10-15 01:53:32 +00:00
:::
::: tip
2023-09-03 01:08:16 +00:00
[Квиток #1252 ](https://github.com/starship/starship/discussions/1252 ) містить приклади власних модулів. Якщо у вас є цікавий приклад ще не розкритий там, не соромтеся, поділитися ним!
2022-10-15 01:53:32 +00:00
:::
2023-09-03 01:08:16 +00:00
::: warning Вихідні дані команди друкуються без екранування
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Незалежно від результату, який генерує команда, він виводиться в командний рядок у незміненому вигляді. Це означає, що якщо вивід містить спеціальні послідовності, які інтерпретуються оболонкою, вони будуть оброблені та перетворені оболонкою при виводі. Ці спеціальні послідовності є специфічними для оболонки, напр. ви можете написати модуль, який записує послідовності bash, наприклад. `\h` , але цей модуль не працюватиме в оболонці fish а б о zsh.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Рядок формату також може містити специфічні послідовності командного рядка, наприклад [Bash ](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html ), [Zsh ](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html ).
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Параметри
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
| Параметр | Стандартно | Опис |
| ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `''` | Команда, вивід якої потрібно показувати. Команду буде передано до оболонки через stdin. |
| `when` | `false` | А б о булеве значення (`true` чи `false` , без лапок) а б о команди shell, що використовуються як умова для показу модуля. У випадку рядка команди, модуль буде показаний, якщо команда повертає код завершення `0` . |
| `require_repo` | `false` | Якщо `true` , модуль буде показано лише в шляхах, що містять репозиторій (git). Цей параметр сам по с о б і не є достатньою умовою для показу модуля за відсутності інших варіантів. |
| `shell` | | [Дивіться нижче ](#custom-command-shell ) |
| `description` | `'<custom module>'` | Опис модуля, який показується під час запуску `starship explain` . |
| `detect_files` | `[]` | Файли, які треба шукати у робочій теці для отримання збігу. |
| `detect_folders` | `[]` | Теки, які треба шукати у робочій теці для отримання збігу. |
| `detect_extensions` | `[]` | Розширення файлів, які треба шукати у робочій теці для отримання збігу. |
| `symbol` | `''` | Символ, який йде перед виводом команди. |
| `style` | `'bold green'` | Стиль модуля. |
| `format` | `'[$symbol($output )]($style)'` | Формат модуля. |
| `disabled` | `false` | Вимикає показ модулі `custom` . |
| `os` | | Назва операційної системи, на якій буде показано модуль (unix, linux, macos, windows, … ) [Переглянути можливі значення ](https://doc.rust-lang.org/std/env/consts/constant.OS.html ). |
| `use_stdin` | | Необов’язкове логічне значення, яке перевизначає, чи команди слід пересилати в оболонку через стандартний ввід чи як аргумент. Якщо не встановлено, типово використовується стандартний ввід, якщо оболонка не підтримує його (cmd, nushell). Встановлення цього параметра вимикає обробку специфічних для оболонки аргументів. |
| `ignore_timeout` | `false` | Ігнорує глобальне налаштування `command_timeout` і продовжує виконувати зовнішні команди, незалежно від того, скільки часу вони вимагають. |
2023-04-12 18:43:40 +00:00
### Змінні
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
| Змінна | Опис |
| --------- | ---------------------------------------- |
2023-09-03 01:08:16 +00:00
| output | Вивід команд в `shell` |
2023-04-11 04:05:27 +00:00
| symbol | Віддзеркалює значення параметра `symbol` |
| style\* | Віддзеркалює значення параметра `style` |
2022-10-15 01:53:32 +00:00
2023-04-11 04:05:27 +00:00
*: Ця змінна може бути використана лише як частина стилю рядка
2022-10-15 01:53:32 +00:00
2023-09-17 00:31:34 +00:00
#### Власні команди shell
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
`shell` приймає непустий список рядків, де:
2022-10-15 01:53:32 +00:00
2023-04-12 18:43:40 +00:00
- Перший рядок — це шлях до оболонки для виконання команди.
- Наступні — інші аргументи, що передаються до оболонки.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Якщо не налаштовано, модуль повертатиметься до STARSHIP_SHELL, а потім до «sh» у Linux і «cmd /C» у Windows.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Команда `command` буде передана до stdin.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Якщо `shell` не вказано а б о містить тільки один елемент і Starship виявить, що буде використано PowerShell, наступні аргументи будуть автоматично додані: `-Noprofile -Command -` . Якщо `shell` не вказано а б о міститься лише один елемент і Starship виявить, що буде використано Cmd, аргумент`/C` буде автоматично додано, а `stdin` буде встановлено у `false` . Якщо `shell` не вказано а б о міститься лише один елемент і Starship виявить, що буде використано Nushell, аргумент`c` буде автоматично додано, а `stdin` буде встановлено у `false` . Такої поведінки можна уникнути шляхом явного передавання аргументів до оболонки, наприклад,
2022-10-15 01:53:32 +00:00
```toml
2022-12-05 06:54:12 +00:00
shell = ['pwsh', '-Command', '-']
2022-10-15 01:53:32 +00:00
```
2023-09-03 01:08:16 +00:00
::: warning Переконайтеся, що ваша оболонка завершує процеси правильно
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Якщо ви вказуєте власну команду, переконайтеся, що стандартний Shell, який використовується starship, буде виконувати команді з чистим (graceful) завершенням, за допомогою параметра `shell` .
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Наприклад, PowerShell потребує параметр `-Command` для виконання однорядкової команди. Пропуск цього параметра може призвести до рекурсивного циклу starship, де оболонка може спробувати знову завантажити повний профіль середовища з самим starship і , отже, повторно виконати власну команду, потрапивши в нескінченний цикл.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Параметри, подібні до `-NoProfile` у PowerShell, також рекомендовані для інших оболонок, щоб уникнути додаткового часу завантаження власного профілю під час кожного виклику Starship.
2022-10-15 01:53:32 +00:00
2023-09-03 01:08:16 +00:00
Наразі реалізовано автоматичне виявлення оболонок і правильне додавання параметрів, але можливо, що охоплено не всі оболонки. [Будь ласка, сповістіть про проблему ](https://github.com/starship/starship/issues/new/choose ) з подробицями про термінал та конфігурацію автозапуску, якщо ви зіткнулись з таким сценарій.
2022-10-15 01:53:32 +00:00
:::
2023-04-11 04:05:27 +00:00
### Приклад
2022-10-15 01:53:32 +00:00
```toml
# ~/.config/starship.toml
[custom.foo]
2022-12-05 06:54:12 +00:00
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 )'
2022-10-15 01:53:32 +00:00
[custom.time]
2022-12-05 06:54:12 +00:00
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command', '-']
2022-10-15 01:53:32 +00:00
[custom.time-as-arg]
2022-12-05 06:54:12 +00:00
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command']
2022-10-15 01:53:32 +00:00
use_stdin = false
```