mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 03:27:30 +00:00

History

Matan Kushner d8dcf04cff docs(i18n): new Crowdin updates (#1512 )		2020-09-30 16:26:13 -04:00
..
README.md	docs(i18n): new Crowdin updates (#1512 )	2020-09-30 16:26:13 -04:00

README.md

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

To get started configuring starship, create the following file: ~/.config/starship.toml.

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

All configuration for starship is done in this TOML file:

# Don't print a new line at the start of the prompt
add_newline = false

# Replace the "❯" symbol in the prompt with "➜"
[character]                            # The name of the module we are configuring is "character"
success_symbol = "[➜](bold green)"     # The "success_symbol" segment is being set to "➜" with the color "bold green"

# Disable the package module, hiding it from the prompt completely
[package]
disabled = true

You can change default starship.toml file location with STARSHIP_CONFIG environment variable:

export STARSHIP_CONFIG=~/.starship

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

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

Logging

By default starship logs warnings and errors into a file named ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log, where the session key is corresponding to a instance of your terminal. This, however can be changed using the STARSHIP_CACHE environment variable:

export STARSHIP_CACHE=~/.starship/cache

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

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

Terminology

Module: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.

Variable: Smaller sub-components that contains information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS.

By convention, most modules have a prefix of default terminal color (e.g. via in "nodejs") and an empty space as a suffix.

Format Strings

Format strings are the format that a module prints all its variables with. Most modules have an entry called format that configures the display format of the module. You can use texts, variables and text groups in a format string.

Переменная

A variable contains a $ symbol followed by the name of the variable. The name of a variable only contains letters, numbers and _.

For example:

$version is a format string with a variable named version.
$git_branch$git_commit is a format string with two variables named git_branch and git_commit.
$git_branch $git_commit has the two variables separated with a space.

Text Group

A text group is made up of two different parts.

The first part, which is enclosed in a [], is a format string. You can add texts, variables, or even nested text groups in it.

In the second part, which is enclosed in a (), is a style string. This can be used style the first part.

For example:

[on](red bold) will print a string on with bold text colored red.
[⬢ $version](bold green) will print a symbol ⬢ followed by the content of variable version, with bold text colored green.
[a [b](red) c](green) will print a b c with b red, and a and c green.

Строки стиля

Most modules in starship allow you to configure their display styles. This is done with an entry (usually called style) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the advanced config guide.

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

Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.

Conditional Format Strings

A conditional format string wrapped in ( and ) will not render if all variables inside are empty.

For example:

(@$region) will show nothing if the variable region is None, otherwise @ followed by the value of region.
(some text) will always show nothing since there are no variables wrapped in the braces.
When $all is a shortcut for \[$a$b\], ($all) will show nothing only if $a and $b are both None. This works the same as (\[$a$b\] ).

Escapable characters

The following symbols have special usage in a format string. If you want to print the following symbols, you have to escape them with a backslash (\).

$
\
[
]
(
)

Note that toml has its own escape syntax. It is recommended to use a literal string ('') in your config. If you want to use a basic string (""), pay attention to escape the backslash \.

For example, when you want to print a $ symbol on a new line, the following configs for format are equivalent:

# with basic string
format = "\n\\$"

# with multiline basic string
format = """

\\$"""

# with literal string
format = '''

\$'''

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

This is the list of prompt-wide configuration options.

Опции

Option	По умолчанию	Описание
`format`	ссылка	Configure the format of the prompt.
`scan_timeout`	`30`	Timeout for starship to scan files (in milliseconds).
`add_newline`	`true`	Add a new line before the start of the prompt.

Пример

# ~/.config/starship.toml

# Use custom format
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """

# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10

# Disable the newline at the start of the prompt
add_newline = false

Default Prompt Format

The default format is used to define the format of the prompt, if empty or no format is provided. The default is as shown:

format = "$all"

# Which is equivalent to
format = """
$username\
$hostname\
$shlvl\
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$ruby\
$rust\
$swift\
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$env_var\
$crystal\
$cmd_duration\
$custom\
$line_break\
$jobs\
$battery\
$time\
$status\
$character"""

AWS

The aws module shows the current AWS region and profile. This is based on AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE env var with ~/.aws/config file.

When using aws-vault the profile is read from the AWS_VAULT env var.

Опции

Option	По умолчанию	Описание
`format`	`"on [$symbol$profile(\$$region\$)]($style) "`	The format for the module.
`symbol`	`"☁️ "`	Символ перед отображением текущего профиля AWS.
`region_aliases`		Таблица региона псевдонимов, отображаемая вместе с именем AWS.
`style`	`"bold yellow"`	Стиль модуля.
`disabled`	`false`	Отключение модуля `AWS`.

Variables

Переменная	Пример	Описание
region	`ap-northeast-1`	The current AWS region
profile	`astronauts`	The current AWS profile
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Examples

Display everything

# ~/.config/starship.toml

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

Display region

# ~/.config/starship.toml

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

Display profile

# ~/.config/starship.toml

[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "

Батарея

The battery module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.

Опции

Option	По умолчанию	Описание
`full_symbol`	`"•"`	Символ, отображаемый при полной батарее.
`charging_symbol`	`"⇡"`	Символ, показываемый при зарядке аккумулятора.
`discharging_symbol`	`"⇣"`	Символ, показываемый при разрядке аккумулятора.
`format`	`"[$symbol$percentage]($style) "`	The format for the module.
`display`	ссылка	Порог отображения и стиль для модуля.
`disabled`	`false`	Отключает модуль `battery`.

There are also options for some uncommon battery states.

Переменная	Описание
`unknown_symbol`	Символ, отображаемый при неизвестном состоянии батареи.
`empty_symbol`	Символ, отображаемый при пустом состоянии батареи.

Note: Battery indicator will be hidden if the status is unknown or empty unless you specify the option in the config.

Пример

# ~/.config/starship.toml

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

Battery Display

The display configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no display is provided. The default is as shown:

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

Опции

The display option is an array of the following table.

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

Пример

[[battery.display]]  # "bold red" style when capacity is between 0% and 10%
threshold = 10
style = "bold red"

[[battery.display]]  # "bold yellow" style when capacity is between 10% and 30%
threshold = 30
style = "bold yellow"

# when capacity is over 30%, the battery indicator will not be displayed

Символ

The character module shows a character (usually an arrow) beside where the text is entered in your terminal.

The character will tell you whether the last command was successful or not. It can do this in two ways:

changing color (red/green)
changing shape (❯/✖)

By default it only changes color. If you also want to change it's shape take a look at this example.

Опции

Option	По умолчанию	Описание
`format`	`"$symbol "`	The format string used before the text input.
`success_symbol`	`"[❯](bold green)"`	The format string used before the text input if the previous command succeeded.
`error_symbol`	`"[❯](bold red)"`	The format string used before the text input if the previous command failed.
`vicmd_symbol`	`"[❮](bold green)"`	The format string used before the text input if the shell is in vim normal mode.
`disabled`	`false`	Отключает модуль `character`.

Variables

Переменная	Пример	Описание
symbol		A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol`

Examples

With custom error shape

# ~/.config/starship.toml

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

Without custom error shape

# ~/.config/starship.toml

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

With custom vim shape

# ~/.config/starship.toml

[character]
vicmd_symbol = "[V](bold green) "

CMake

The cmake module shows the currently installed version of CMake if:

The current directory contains a CMakeLists.txt file

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"🛆 "`	The symbol used before the version of cmake.
`style`	`"bold blue"`	Стиль модуля.
`disabled`	`false`	Disables the `cmake` module.

Variables

Переменная	Пример	Описание
version	`v3.17.3`	The version of cmake
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

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

The cmd_duration module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the min_time config value, if it exists.

::: warning Do not hook the DEBUG trap in Bash

If you are running Starship in bash, do not hook the DEBUG trap after running eval $(starship init $0), or this module will break.

:::

Bash users who need preexec-like functionality can use rcaloras's bash_preexec framework. Simply define the arrays preexec_functions and precmd_functions before running eval $(starship init $0), and then proceed as normal.

Опции

Option	По умолчанию	Описание
`min_time`	`2_000`	Кратчайшая продолжительность для показа времени (в миллисекундах).
`show_milliseconds`	`false`	Показывать миллисекунды в дополнение к секундам в продолжительности.
`format`	`"took [$duration]($style) "`	The format for the module.
`style`	`"bold yellow"`	Стиль модуля.
`disabled`	`false`	Отключает модуль `cmd_duration`.

Variables

Переменная	Пример	Описание
duration	`16m40s`	The time it took to execute the command
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Конда

The conda module shows the current conda environment, if $CONDA_DEFAULT_ENV is set.

::: tip

This does not suppress conda's own prompt modifier, you may want to run conda config --set changeps1 False.

:::

Опции

Option	По умолчанию	Описание
`truncation_length`	`1`	Количество каталогов, в которых путь к окружению должен быть усечен, если окружение было создано через `conda create -p [path]`. `0` означает без усечения. Также смотрите модуль `directory`.
`symbol`	`"🅒 "`	Символ перед названием окружения.
`style`	`"bold green"`	Стиль модуля.
`format`	`"[$symbol$environment]($style) "`	The format for the module.
`ignore_base`	`true`	Ignores `base` environment when activated.
`disabled`	`false`	Disables the `conda` module.

Variables

Переменная	Пример	Описание
environment	`astronauts`	The current conda environment
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Crystal

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

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

Опции

Option	По умолчанию	Описание
`symbol`	`"🔮 "`	Символ, используемый перед отображением версии crystal.
`style`	`"bold red"`	Стиль модуля.
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`disabled`	`false`	Отключает модуль `crystal`.

Variables

Переменная	Пример	Описание
version	`v0.32.1`	The version of `crystal`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Dart

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

The current directory contains a file with .dart extension
The current directory contains a .dart_tool directory
The current directory contains a pubspec.yaml or pubspec.lock file

Опции

Переменная	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"🎯 "`	A format string representing the symbol of Dart
`style`	`"bold blue"`	Стиль модуля.
`disabled`	`false`	Disables the `dart` module.

Variables

Переменная	Пример	Описание
version	`v2.8.4`	The version of `dart`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Переменная	По умолчанию	Описание
`truncation_length`	`3`	The number of parent folders that the current directory should be truncated to.
`truncate_to_repo`	`true`	Whether or not to truncate to the root of the git repo that you're currently in.
`format`	`"[$path]($style)[$lock_symbol]($lock_style) "`	The format for the module.
`style`	`"bold cyan"`	Стиль модуля.
`disabled`	`false`	Disables the `directory` module.
`read_only_symbol`	`"🔒"`	The symbol indicating current directory is read only.
`read_only_symbol_style`	`"red"`	The style for the read only symbol.

Advanced Option	По умолчанию	Описание
`substitutions`		A table of substitutions to be made to the path.
`fish_style_pwd_dir_length`	`0`	The number of characters to use when applying fish shell pwd path logic.
`use_logical_path`	`true`	Displays the logical path provided by the shell (`PWD`) instead of the path from the OS.

Переменная	Пример	Описание
path	`"D:/Projects"`	The current directory path
style*	`"black bold dimmed"`	Mirrors the value of option `style`

Docker Context

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

Опции

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

Variables

Переменная	Пример	Описание
context	`test_context`	The current docker context
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Dotnet

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

This module will only be shown in your prompt when one or more of the following files are present in the current directory:

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

You'll also need the .NET Core SDK installed in order to use it correctly.

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

The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) when there is a csproj file in the current directory.

Опции

Option	По умолчанию	Описание
`format`	`"v[$symbol$version( 🎯 $tfm)]($style) "`	The format for the module.
`symbol`	`"•NET "`	The symbol used before displaying the version of dotnet.
`heuristic`	`true`	Use faster version detection to keep starship snappy.
`style`	`"bold blue"`	Стиль модуля.
`disabled`	`false`	Disables the `dotnet` module.

Variables

Переменная	Пример	Описание
version	`v3.1.201`	The version of `dotnet` sdk
tfm	`netstandard2.0`	The Target Framework Moniker that the current project is targeting
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Elixir

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

The current directory contains a mix.exs file.

Опции

Option	По умолчанию	Описание
`symbol`	`"💧 "`	The symbol used before displaying the version of Elixir/Erlang.
`style`	`"bold purple"`	Стиль модуля.
`format`	`"via [$symbol$version \$OTP $otp_version\$]($style) "`	The format for the module elixir.
`disabled`	`false`	Disables the `elixir` module.

Variables

Переменная	Пример	Описание
version	`v1.10`	The version of `elixir`
otp_version		The otp version of `elixir`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

Elm

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

The current directory contains a elm.json file
The current directory contains a elm-package.json file
The current directory contains a .elm-version file
The current directory contains a elm-stuff folder
The current directory contains a *.elm files

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"🌳 "`	A format string representing the symbol of Elm.
`style`	`"cyan bold"`	Стиль модуля.
`disabled`	`false`	Disables the `elm` module.

Variables

Переменная	Пример	Описание
version	`v0.19.1`	The version of `elm`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Environment Variable

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

The variable configuration option matches an existing environment variable
The variable configuration option is not defined, but the default configuration option is

Опции

Option	По умолчанию	Описание
`symbol`		The symbol used before displaying the variable value.
`variable`		The environment variable to be displayed.
`default`		The default value to be displayed when the selected variable is not defined.
`format`	`"with [$env_value]($style) "`	The format for the module.
`disabled`	`false`	Disables the `env_var` module.

Variables

Переменная	Пример	Описание
env_value	`Windows NT` (if variable would be `$OS`)	The environment value of option `variable`
symbol		Mirrors the value of option `symbol`
style*	`black bold dimmed`	Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Erlang

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

The current directory contains a rebar.config file.
The current directory contains a erlang.mk file.

Опции

Option	По умолчанию	Описание
`symbol`	`"🖧 "`	The symbol used before displaying the version of erlang.
`style`	`"bold red"`	Стиль модуля.
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`disabled`	`false`	Disables the `erlang` module.

Variables

Переменная	Пример	Описание
version	`v22.1.3`	The version of `erlang`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Gcloud

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

Опции

Переменная	По умолчанию	Описание
`format`	`"on [$symbol$account(\$$region\$)]($style) "`	The format for the module.
`symbol`	`"☁️ "`	The symbol used before displaying the current GCP profile.
`region_aliases`		Table of region aliases to display in addition to the GCP name.
`style`	`"bold blue"`	Стиль модуля.
`disabled`	`false`	Disables the `gcloud` module.

Variables

Переменная	Пример	Описание
region	`us-central1`	The current GCP region
account	`foo@example.com`	The current GCP profile
project		The current GCP project
active	`default`	The active config name written in `~/.config/gcloud/active_config`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Examples

Display account and project

# ~/.config/starship.toml

[gcloud]
format = "on [$symbol$account(\\($project\\))]($style) "

Display active config name only

# ~/.config/starship.toml

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

Display account and aliased region

# ~/.config/starship.toml

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

Git Branch

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

Опции

Option	По умолчанию	Описание
`format`	`"on [$symbol$branch]($style) "`	The format for the module. Use `"$branch"` to refer to the current branch name.
`symbol`	`" "`	A format string representing the symbol of git branch.
`style`	`"bold purple"`	Стиль модуля.
`truncation_length`	`2^63 - 1`	Truncates a git branch to X graphemes.
`truncation_symbol`	`"…"`	The symbol used to indicate a branch name was truncated. You can use `""` for no symbol.
`disabled`	`false`	Disables the `git_branch` module.

Variables

Переменная	Пример	Описание
branch	`master`	The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD).
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Git Commit

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

Опции

Option	По умолчанию	Описание
`commit_hash_length`	`7`	The length of the displayed git commit hash.
`format`	`"[\$$hash\$]($style) "`	The format for the module.
`style`	`"bold green"`	Стиль модуля.
`only_detached`	`true`	Only show git commit hash when in detached HEAD state
`disabled`	`false`	Disables the `git_commit` module.

Variables

Переменная	Пример	Описание
hash	`b703eb3`	The current git commit hash
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4

Git State

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

Опции

Option	По умолчанию	Описание
`rebase`	`"REBASING"`	A format string displayed when a `rebase` is in progress.
`merge`	`"MERGING"`	A format string displayed when a `merge` is in progress.
`revert`	`"REVERTING"`	A format string displayed when a `revert` is in progress.
`cherry_pick`	`"CHERRY-PICKING"`	A format string displayed when a `cherry-pick` is in progress.
`bisect`	`"BISECTING"`	A format string displayed when a `bisect` is in progress.
`am`	`"AM"`	A format string displayed when an `apply-mailbox` (`git am`) is in progress.
`am_or_rebase`	`"AM/REBASE"`	A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress.
`style`	`"bold yellow"`	Стиль модуля.
`format`	`"\$[$state( $progress_current/$progress_total)]($style)\$ "`	The format for the module.
`disabled`	`false`	Disables the `git_state` module.

Variables

Переменная	Пример	Описание
state	`REBASING`	The current state of the repo
progress_current	`1`	The current operation progress
progress_total	`2`	The total operation progress
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Git Status

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

Опции

Option	По умолчанию	Описание
`format`	`"[\[$all_status$ahead_behind\]]($style) "`	The default format for `git_status`
`conflicted`	`"="`	This branch has merge conflicts.
`ahead`	`"⇡"`	The format of `ahead`
`behind`	`"⇣"`	The format of `behind`
`diverged`	`"⇕"`	The format of `diverged`
`untracked`	`"?"`	The format of `untracked`
`stashed`	`"$"`	The format of `stashed`
`modified`	`"!"`	The format of `modified`
`staged`	`"+"`	The format of `staged`
`renamed`	`"»"`	The format of `renamed`
`deleted`	`"✘"`	The format of `deleted`
`style`	`"bold red"`	Стиль модуля.
`disabled`	`false`	Disables the `git_status` module.

Variables

The following variables can be used in format:

Переменная	Описание
`all_status`	Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked`
`ahead_behind`	Displays `diverged` `ahead` or `behind` format string based on the current status of the repo
`conflicted`	Displays `conflicted` when this branch has merge conflicts.
`untracked`	Displays `untracked` when there are untracked files in the working directory.
`stashed`	Displays `stashed` when a stash exists for the local repository.
`modified`	Displays `modified` when there are file modifications in the working directory.
`staged`	Displays `staged` when a new file has been added to the staging area.
`renamed`	Displays `renamed` when a renamed file has been added to the staging area.
`deleted`	Displays `deleted` when a file's deletion has been added to the staging area.
style*	Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

The following variables can be used in diverged:

Переменная	Описание
`ahead_count`	Number of commits ahead of the tracking branch
`behind_count`	Number of commits behind the tracking branch

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

Переменная	Описание
`count`	Show the number of files

Пример

# ~/.config/starship.toml

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

Show ahead/behind count of the branch being tracked

# ~/.config/starship.toml

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

Golang

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

The current directory contains a go.mod file
The current directory contains a go.sum file
The current directory contains a glide.yaml file
The current directory contains a Gopkg.yml file
The current directory contains a Gopkg.lock file
The current directory contains a .go-version file
The current directory contains a Godeps directory
The current directory contains a file with the .go extension

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"🐹 "`	A format string representing the symbol of Go.
`style`	`"bold cyan"`	Стиль модуля.
`disabled`	`false`	Disables the `golang` module.

Variables

Переменная	Пример	Описание
version	`v1.12.1`	The version of `go`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Helm

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

The current directory contains a helmfile.yaml file
The current directory contains a Chart.yaml file

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"⎈ "`	A format string representing the symbol of Helm.
`style`	`"bold white"`	Стиль модуля.
`disabled`	`false`	Disables the `helm` module.

Variables

Переменная	Пример	Описание
version	`v3.1.1`	The version of `helm`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Hostname

The hostname module shows the system hostname.

Опции

Option	По умолчанию	Описание
`ssh_only`	`true`	Only show hostname when connected to an SSH session.
`trim_at`	`"."`	String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation
`format`	`"[$hostname]($style) in "`	The format for the module.
`style`	`"bold dimmed green"`	Стиль модуля.
`disabled`	`false`	Disables the `hostname` module.

Variables

Переменная	Пример	Описание
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Java

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [${symbol}${version}]($style) "`	The format for the module.
`symbol`	`"☕ "`	A format string representing the symbol of Java
`style`	`"red dimmed"`	Стиль модуля.
`disabled`	`false`	Disables the `java` module.

Variables

Переменная	Пример	Описание
version	`v14`	The version of `java`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[java]
symbol = "🌟 "

Jobs

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists.

Опции

Option	По умолчанию	Описание
`threshold`	`1`	Show number of jobs if exceeded.
`format`	`"[$symbol$number]($style) "`	The format for the module.
`symbol`	`"✦"`	A format string representing the number of jobs.
`style`	`"bold blue"`	Стиль модуля.
`disabled`	`false`	Disables the `jobs` module.

Variables

Переменная	Пример	Описание
number	`1`	The number of jobs
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

Julia

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

The current directory contains a Project.toml file
The current directory contains a Manifest.toml file
The current directory contains a file with the .jl extension

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"ஃ "`	A format string representing the symbol of Julia.
`style`	`"bold purple"`	Стиль модуля.
`disabled`	`false`	Disables the `julia` module.

Variables

Переменная	Пример	Описание
version	`v1.4.0`	The version of `julia`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[julia]
symbol = "∴ "

Kubernetes

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

::: tip

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

:::

Опции

Option	По умолчанию	Описание
`symbol`	`"☸ "`	A format string representing the symbol displayed before the Cluster.
`format`	`"[$symbol$context( \$$namespace\$)]($style) in "`	The format for the module.
`style`	`"cyan bold"`	Стиль модуля.
`namespace_spaceholder`	`none`	The value to display if no namespace was found.
`context_aliases`		Table of context aliases to display.
`disabled`	`true`	Disables the `kubernetes` module.

Variables

Переменная	Пример	Описание
context	`starship-cluster`	The current kubernetes context
namespace	`starship-namespace`	If set, the current kubernetes namespace
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[kubernetes]
format = "on [⛵ $context \\($namespace\\)](dimmed green) "
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"

Line Break

The line_break module separates the prompt into two lines.

Опции

Option	По умолчанию	Описание
`disabled`	`false`	Disables the `line_break` module, making the prompt a single line.

Пример

# ~/.config/starship.toml

[line_break]
disabled = true

Memory Usage

The memory_usage module shows current system memory and swap usage.

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

::: tip

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

:::

Опции

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

Variables

Переменная	Пример	Описание
ram	`31GiB/65GiB`	The usage/total RAM of the current system memory.
ram_pct	`48%`	The percentage of the current system memory.
swap**	`1GiB/4GiB`	The swap memory size of the current system swap memory file.
swap_pct**	`77%`	The swap memory percentage of the current system swap memory file.
symbol	`🐏`	Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

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

Пример

# ~/.config/starship.toml

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

Mercurial Branch

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

Опции

Option	По умолчанию	Описание
`symbol`	`" "`	The symbol used before the hg bookmark or branch name of the repo in your current directory.
`style`	`"bold purple"`	Стиль модуля.
`format`	`"on [$symbol$branch]($style) "`	The format for the module.
`truncation_length`	`2^63 - 1`	Truncates the hg branch name to X graphemes
`truncation_symbol`	`"…"`	The symbol used to indicate a branch name was truncated.
`disabled`	`true`	Disables the `hg_branch` module.

Variables

Переменная	Пример	Описание
branch	`master`	The active mercurial branch
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Nim

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module
`symbol`	`"👑 "`	The symbol used before displaying the version of Nim.
`style`	`"bold yellow"`	Стиль модуля.
`disabled`	`false`	Disables the `nim` module.

Variables

Переменная	Пример	Описание
version	`v1.2.0`	The version of `nimc`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Nix-shell

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

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$state( \$$name\$)]($style) "`	The format for the module.
`symbol`	`"❄️ "`	A format string representing the symbol of nix-shell.
`style`	`"bold blue"`	Стиль модуля.
`impure_msg`	`"impure"`	A format string shown when the shell is impure.
`pure_msg`	`"pure"`	A format string shown when the shell is pure.
`disabled`	`false`	Disables the `nix_shell` module.

Variables

Переменная	Пример	Описание
state	`pure`	The state of the nix-shell
name	`lorri`	The name of the nix-shell
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

NodeJS

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

The current directory contains a package.json file
The current directory contains a .node-version file
The current directory contains a node_modules directory
The current directory contains a file with the .js, .mjs or .cjs extension
The current directory contains a file with the .ts extension

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"⬢ "`	A format string representing the symbol of NodeJS.
`style`	`"bold green"`	Стиль модуля.
`disabled`	`false`	Disables the `nodejs` module.

Variables

Переменная	Пример	Описание
version	`v13.12.0`	The version of `node`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Package Version

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

npm – The npm package version is extracted from the package.json present in the current directory
cargo – The cargo package version is extracted from the Cargo.toml present in the current directory
poetry – The poetry package version is extracted from the pyproject.toml present in the current directory
composer – The composer package version is extracted from the composer.json present in the current directory
gradle – The gradle package version is extracted from the build.gradle present
julia - The package version is extracted from the Project.toml present
mix - The mix package version is extracted from the mix.exs present
helm - The helm chart version is extracted from the Chart.yaml present
maven - The maven package version is extracted from the pom.xml present

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

Опции

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

Variables

Переменная	Пример	Описание
version	`v1.0.0`	The version of your package
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

OCaml

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

The current directory contains a file with .opam extension or _opam directory
The current directory contains a esy.lock directory
The current directory contains a dune or dune-project file
The current directory contains a jbuild or jbuild-ignore file
The current directory contains a .merlin file
The current directory contains a file with .ml, .mli, .re or .rei extension

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format string for the module.
`symbol`	`"🐫 "`	The symbol used before displaying the version of OCaml.
`style`	`"bold yellow"`	Стиль модуля.
`disabled`	`false`	Disables the `ocaml` module.

Variables

Переменная	Пример	Описание
version	`v4.10.0`	The version of `ocaml`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Perl

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

The current directory contains a Makefile.PL or Build.PL file
The current directory contains a cpanfile or cpanfile.snapshot file
The current directory contains a META.json file or META.yml file
The current directory contains a .perl-version file
The current directory contains a .pl, .pm or .pod

Опции

Переменная	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format string for the module.
`symbol`	`"🐪 "`	The symbol used before displaying the version of Perl
`style`	`"bold 149"`	Стиль модуля.
`disabled`	`false`	Disables the `perl` module.

Variables

Переменная	Пример	Описание
version	`v5.26.1`	The version of `perl`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

Пример

# ~/.config/starship.toml

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

PHP

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"🐘 "`	The symbol used before displaying the version of PHP.
`style`	`"147 bold"`	Стиль модуля.
`disabled`	`false`	Disables the `php` module.

Variables

Переменная	Пример	Описание
version	`v7.3.8`	The version of `php`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Python

The python module shows the currently installed version of Python and the current Python virtual environment if one is activated.

If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [${symbol}${pyenv_prefix}${version}( \$$virtualenv\$)]($style) "`	The format for the module.
`symbol`	`"🐍 "`	A format string representing the symbol of Python
`style`	`"yellow bold"`	Стиль модуля.
`pyenv_version_name`	`false`	Use pyenv to get Python version
`pyenv_prefix`	`pyenv`	Prefix before pyenv version display, only used if pyenv is used
`scan_for_pyfiles`	`true`	If false, Python files in the current directory will not show this module.
`disabled`	`false`	Disables the `python` module.

Variables

Переменная	Пример	Описание
version	`"v3.8.1"`	The version of `python`
symbol	`"🐍 "`	Mirrors the value of option `symbol`
style	`"yellow bold"`	Mirrors the value of option `style`
pyenv_prefix	`"pyenv "`	Mirrors the value of option `pyenv_prefix`
virtualenv	`"venv"`	The current `virtualenv` name

This module has some advanced configuration options.

Переменная	По умолчанию	Описание
`python_binary`	`python`	Configures the python binary that Starship executes when getting the version.

The python_binary variable changes the binary that Starship executes to get the version of Python, it doesn't change the arguments that are used.

# ~/.config/starship.toml

[python]
python_binary = "python3"

Пример

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true

Ruby

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"💎 "`	A format string representing the symbol of Ruby.
`style`	`"bold red"`	Стиль модуля.
`disabled`	`false`	Disables the `ruby` module.

Variables

Переменная	Пример	Описание
version	`v2.5.1`	The version of `ruby`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"🦀 "`	A format string representing the symbol of Rust
`style`	`"bold red"`	Стиль модуля.
`disabled`	`false`	Disables the `rust` module.

Variables

Переменная	Пример	Описание
version	`v1.43.0-nightly`	The version of `rustc`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

SHLVL

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

Опции

Переменная	По умолчанию	Описание
`threshold`	`2`	Display threshold.
`format`	`"[$symbol$shlvl]($style) "`	The format for the module.
`symbol`	`"↕️ "`	The symbol used to represent the SHLVL.
`style`	`"bold yellow"`	Стиль модуля.
`disabled`	`true`	Disables the `shlvl` module.

Variables

Переменная	Пример	Описание
shlvl	`3`	The current value of SHLVL
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Singularity

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

Опции

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

Variables

Переменная	Пример	Описание
env	`centos.img`	The current singularity image
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Swift

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

The current directory contains a Package.swift file
The current directory contains a file with the .swift extension

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"🐦 "`	A format string representing the symbol of Swift
`style`	`"bold 202"`	Стиль модуля.
`disabled`	`false`	Disables the `swift` module.

Variables

Переменная	Пример	Описание
version	`v5.2.4`	The version of `swift`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Status

The status module displays the exit code of the previous command. The module will be shown only if the exit code is not 0.

::: tip

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

Опции

Переменная	По умолчанию	Описание
`format`	`[$symbol$status]($style)`	The format of the module
`symbol`	`"✖"`	A format string representing the symbol for the status
`style`	`"bold red"`	Стиль модуля.
`disabled`	`true`	Disables the `status` module.

Variables

Переменная	Пример	Описание
status	`127`	The exit code of the last command
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример


# ~/.config/starship.toml

[status]
style = "bg:blue"
symbol = "💣 "
format = "[\\[$symbol$status\\]]($style) "
disabled = false

Terraform

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$workspace]($style) "`	The format string for the module.
`symbol`	`"💠 "`	A format string shown before the terraform workspace.
`style`	`"bold 105"`	Стиль модуля.
`disabled`	`false`	Disables the `terraform` module.

Variables

Переменная	Пример	Описание
version	`v0.12.24`	The version of `terraform`
workspace	`default`	The current terraform workspace
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

With Version

# ~/.config/starship.toml

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

Without version

# ~/.config/starship.toml

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

Time

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

::: tip

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

:::

Опции

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

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

Variables

Переменная	Пример	Описание
time	`13:08:10`	The current time.
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Username

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

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

Опции

Option	По умолчанию	Описание
`style_root`	`"bold red"`	The style used when the user is root.
`style_user`	`"bold yellow"`	The style used for non-root users.
`format`	`"[$user]($style) in "`	The format for the module.
`show_always`	`false`	Always shows the `username` module.
`disabled`	`false`	Disables the `username` module.

Variables

Переменная	Пример	Описание
`style`	`"red bold"`	Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise.
`user`	`"matchai"`	The currently logged-in user ID.

Пример

# ~/.config/starship.toml

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

Zig

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

The current directory contains a .zig file

Опции

Option	По умолчанию	Описание
`symbol`	`"↯ "`	The symbol used before displaying the version of Zig.
`style`	`"bold yellow"`	Стиль модуля.
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`disabled`	`false`	Disables the `zig` module.

Variables

Переменная	Пример	Описание
version	`v0.6.0`	The version of `zig`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

[zig]
symbol = "⚡️ "

Custom commands

The custom modules show the output of some arbitrary commands.

These modules will be shown if any of the following conditions are met:

The current directory contains a file whose name is in files
The current directory contains a directory whose name is in directories
The current directory contains a file whose extension is in extensions
The when command returns 0

::: tip

Multiple custom modules can be defined by using a ..

:::

::: tip

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

:::

::: tip

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

:::

Опции

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

Variables

Переменная	Описание
output	The output of shell command in `shell`
symbol	Mirrors the value of option `symbol`
style*	Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Custom command shell

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

The first string is the path to the shell to use to execute the command.
Other following arguments are passed to the shell.

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

The command will be passed in on stdin.

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

shell = ["pwsh", "-Command", "-"]

::: warning Make sure your custom shell configuration exits gracefully

If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell option).

For example, PowerShell requires the -Command parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.

Parameters similar to -NoProfile in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.

Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.

:::

Пример

# ~/.config/starship.toml

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

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

PureScript

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

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

Опции

Option	По умолчанию	Описание
`format`	`"via [$symbol$version]($style) "`	The format for the module.
`symbol`	`"<=> "`	The symbol used before displaying the version of PureScript.
`style`	`"bold white"`	Стиль модуля.
`disabled`	`false`	Disables the `purescript` module.

Variables

Переменная	Пример	Описание
version	`0.13.5`	The version of `purescript`
symbol		Mirrors the value of option `symbol`
style*		Mirrors the value of option `style`

*: This variable can only be used as a part of a style string

Пример

# ~/.config/starship.toml

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

Option	По умолчанию	Описание
`format`	`"on [$symbol$profile(\\($region\\))]($style) "`	The format for the module.
`symbol`	`"☁️ "`	Символ перед отображением текущего профиля AWS.
`region_aliases`		Таблица региона псевдонимов, отображаемая вместе с именем AWS.
`style`	`"bold yellow"`	Стиль модуля.
`disabled`	`false`	Отключение модуля `AWS`.

Переменная	По умолчанию	Описание
`format`	`"on [$symbol$account(\\($region\\))]($style) "`	The format for the module.
`symbol`	`"☁️ "`	The symbol used before displaying the current GCP profile.
`region_aliases`		Table of region aliases to display in addition to the GCP name.
`style`	`"bold blue"`	Стиль модуля.
`disabled`	`false`	Disables the `gcloud` module.

Option	По умолчанию	Описание
`format`	`"via [$symbol$state( \\($name\\))]($style) "`	The format for the module.
`symbol`	`"❄️ "`	A format string representing the symbol of nix-shell.
`style`	`"bold blue"`	Стиль модуля.
`impure_msg`	`"impure"`	A format string shown when the shell is impure.
`pure_msg`	`"pure"`	A format string shown when the shell is pure.
`disabled`	`false`	Disables the `nix_shell` module.

README.md Unescape Escape

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

Logging

Terminology

Format Strings

Переменная

Text Group

Строки стиля

Conditional Format Strings

Escapable characters

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

Опции

Пример

Default Prompt Format

AWS

Опции

Variables

Examples

Display everything

Display region

Display profile

Батарея

Опции

Пример

Battery Display

Опции

Пример

Символ

Опции

Variables

Examples

With custom error shape

Without custom error shape

With custom vim shape

CMake

Опции

Variables

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

Опции

Variables

Пример

Конда

Опции

Variables

Пример

Crystal

Опции

Variables

Пример

Dart

Опции

Variables

Пример

Directory

Опции

Variables

Пример

Docker Context

Опции

Variables

Пример

Dotnet

Опции

Variables

Пример

Elixir

Опции

Variables

Пример

Elm

Опции

Variables

Пример

Environment Variable

Опции

Variables

Пример

Erlang

Опции

Variables

README.md