starship/docs/zh-CN/config

配置

您需要创建配置文件 ~/.config/starship.toml 以供 Starship 使用。

mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml

Starship 的所有配置都在此 TOML 配置文件中完成：

# Inserts a blank line between shell prompts
add_newline = true

# 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 configuration file location with STARSHIP_CONFIG environment variable:

export STARSHIP_CONFIG=~/.starship/config.toml

在 PowerShell (Windows) 中，在 $PROFILE 中添加下面的代码行能达到同样的效果：

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

日志

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

在 PowerShell (Windows) 中，在 $PROFILE 中添加下面的代码行能达到同样的效果：

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

术语

组件（Module）：提示符的组成部分，通过来自系统的上下文信息向用户显示各种信息。 比如“nodejs”组件会在当前目录是一个 NodeJS 项目时显示您当前安装的 NodeJS 版本。

Variable: Smaller sub-components that contain 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.

样式设定

Starship 中的大多数组件允许您为其设置显示样式。 显示样式可以通过一个字符串字段（一般是 style）来设置。 以下的例子给出了一些样式字符串并描述了它们的效果。 样式字符串的完整语法请查阅 高级配置指南。

• "fg:green bg:blue" 在蓝色背景上显示绿色文本
• "bg:blue fg:bright-green" 在蓝色背景上显示亮绿色文本
• "bold fg:27" 设置粗体字，用 27 号 ANSI 标准色
• "underline bg:#bf5700" 在深橙色背景上显示带下划线文本
• "bold italic fg:purple" 设置文本为粗体、意大利体，颜色为紫色
• "" 显式禁用所有样式

请注意，最终的显示样式将由您的终端模拟器控制。 例如，有的终端模拟器对于“bold”属性的文本是加亮颜色而不是加粗文字，有的颜色主题对“普通”和“明亮”两种属性的颜色使用相同的颜色值。 此外，要获得意大利体文本（一般设计为斜体），您的终端必须支持意大利体显示。

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 = '''

\$'''

提示符

以下是关于提示符的配置项。

配置项

Option	默认值	描述
format	见下文	Configure the format of the prompt.
scan_timeout	30	Starship 扫描文件的超时时间（单位：毫秒）。
add_newline	true	Inserts blank line between shell prompts.

示例

# ~/.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 blank line 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. 默认设置如下：

format = "$all"

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

AWS

aws 组件显示当前 AWS 主机所在区域与配置信息。 各组件基于 AWS_REGION，AWS_DEFAULT_REGION 和 AWS_PROFILE 环境变量与 ~/.aws/config 文件。

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

When using awsu the profile is read from the AWSU_PROFILE env var.

配置项

Option	默认值	描述
format	'on [$symbol($profile )(\($region\) )]($style)'	组件格式化模板。
symbol	"☁️ "	这个字段的内容会显示在当前 AWS 配置信息之前。
region_aliases		地区缩写列表，用来显示在 AWS 主机名之后。
style	"bold yellow"	此组件的样式。
disabled	false	Disables the aws module.

Variables

字段	示例	描述
region	ap-northeast-1	The current AWS region
profile	astronauts	The current AWS profile
symbol		symbol对应值
style*		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 = "🅰 "

Battery

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	" "	显示于电池放电时。
unknown_symbol	" "	显示于电池状态未知时
empty_symbol	" "	显示于电池状态为空时
format	"[$symbol$percentage]($style) "	组件格式化模板。
display	见下文	电量显示阈值和样式。
disabled	false	禁用 battery 组件。

示例

# ~/.config/starship.toml

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

Battery 组件的显示

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. 默认设置如下：

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

配置项

The display option is an array of the following table.

Option	描述
threshold	当前显示设置的电量上限（见示例）
style	若组件被显示，则使用此样式

示例

[[battery.display]]  # 当电量在 0% 到 10% 时以 "bold red" 样式显示
threshold = 10
style = "bold red"

[[battery.display]]  # 当电量在 10% 到 30% 时以 "bold yellow" 样式显示
threshold = 30
style = "bold yellow"

# 当电量在 30% 时以上时，电池指示器组件将不会显示出来

Character

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.

::: warning error_symbol is not supported on elvish shell. :::

配置项

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. By default the module will be activated if any of the following conditions are met:

• The current directory contains a CMakeLists.txt file
• The current directory contains a CMakeCache.txt file

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"△ "	The symbol used before the version of cmake.
detect_extensions	[]	Which extensions should trigger this module
detect_files	["CMakeLists.txt", "CMakeCache.txt"]	Which filenames should trigger this module
detect_folders	[]	Which folders should trigger this module
style	"bold blue"	此组件的样式。
disabled	false	Disables the cmake module.

Variables

字段	示例	描述
version	v3.17.3	The version of cmake
symbol		symbol对应值
style*		style对应值

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

Command Duration

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) "	组件格式化模板。
style	"bold yellow"	此组件的样式。
disabled	false	禁用 cmd_duration 组件。
show_notifications	false	Show desktop notifications when command completes.
min_time_to_notify	45_000	Shortest duration for notification (in milliseconds).

::: tip

Showing desktop notifications requires starship to be built with rust-notify support. You check if your starship supports notifications by running STARSHIP_LOG=debug starship module cmd_duration -d 60000 when show_notifications is set to true.

:::

Variables

字段	示例	描述
duration	16m40s	The time it took to execute the command
style*		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)"

Conda

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 环境是通过 conda create -p [path] 创建的，环境路径的目录深度应该被截断到此数量。 0 表示不用截断。 另请参阅 directory 组件。
symbol	"🅒 "	在环境名之前显示的符号。
style	"bold green"	此组件的样式。
format	"via [$symbol$environment]($style) "	组件格式化模板。
ignore_base	true	Ignores base environment when activated.
disabled	false	禁用 conda 组件。

Variables

字段	示例	描述
environment	astronauts	The current conda environment
symbol		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含一个 shard.yml 文件
• The current directory contains a .cr file

配置项

Option	默认值	描述
symbol	"🔮 "	The symbol used before displaying the version of crystal.
style	"bold red"	此组件的样式。
detect_extensions	["cr"]	Which extensions should trigger this module.
detect_files	["shard.yml"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
format	"via [$symbol($version )]($style)"	组件格式化模板。
disabled	false	Disables the crystal module.

Variables

字段	示例	描述
version	v0.32.1	The version of crystal
symbol		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

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

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"🎯 "	A format string representing the symbol of Dart
detect_extensions	['dart']	Which extensions should trigger this module.
detect_files	["pubspec.yaml", "pubspec.yml", "pubspec.lock"]	Which filenames should trigger this module.
detect_folders	[".dart_tool"]	Which folders should trigger this module.
style	"bold blue"	此组件的样式。
disabled	false	Disables the dart module.

Variables

字段	示例	描述
version	v2.8.4	The version of dart
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Directory

The directory module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.

When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.

For example, given ~/Dev/Nix/nixpkgs/pkgs where nixpkgs is the repo root, and the option set to 1. You will now see ~/D/N/nixpkgs/pkgs, whereas before it would have been nixpkgs/pkgs.

配置项

Option	默认值	描述
truncation_length	3	当前目录路径被截断后最多保留的父目录数量。
truncate_to_repo	true	是否只截断到您当前处于的 git 仓库根目录下。
format	"[$path]($style)[$read_only]($read_only_style) "	组件格式化模板。
style	"bold cyan"	此组件的样式。
disabled	false	禁用 directory 组件。
read_only	"🔒"	The symbol indicating current directory is read only.
read_only_style	"red"	The style for the read only symbol.
truncation_symbol	""	The symbol to prefix to truncated paths. eg: "…/"
home_symbol	"~"	The symbol indicating home directory.

This module has a few advanced configuration options that control how the directory is displayed.

Advanced Option	默认值	描述
substitutions		A table of substitutions to be made to the path.
fish_style_pwd_dir_length	0	使用 fish shell 当前目录路径逻辑时每个省略目录名使用的字符数。
use_logical_path	true	If true render the logical path sourced from the shell via PWD or --logical-path. If false instead render the physical filesystem path with symlinks resolved.

substitutions allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.

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

fish_style_pwd_dir_length interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll, which would normally be displayed as as rock/and/roll, would be displayed as /b/t/c/o/rock/and/roll with fish_style_pwd_dir_length = 1--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2, it would be /bu/th/ci/on/rock/and/roll.

Variables

字段	示例	描述
path	"D:/Projects"	The current directory path
style*	"black bold dimmed"	style对应值

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

示例

# ~/.config/starship.toml

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

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) "	组件格式化模板。
symbol	"🐳 "	The symbol used before displaying the Docker context.
only_with_files	true	Only show when there's a match
detect_extensions	[]	Which extensions should trigger this module (needs only_with_files to be true).
detect_files	["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]	Which filenames should trigger this module (needs only_with_files to be true).
detect_folders	[]	Which folders should trigger this module (needs only_with_files to be true).
style	"blue bold"	此组件的样式。
disabled	false	Disables the docker_context module.

Variables

字段	示例	描述
context	test_context	The current docker context
symbol		symbol对应值
style*		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.

By default 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	"[$symbol($version )(🎯 $tfm )]($style)"	组件格式化模板。
symbol	".NET "	这个字段的内容会显示在当前 .NET 版本之前。
heuristic	true	使用更快的版本探测机制以保证 starship 的运行速度。
detect_extensions	["sln", "csproj", "fsproj", "xproj"]	Which extensions should trigger this module.
detect_files	["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this modules.
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		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含一个 mix.exs 文件.

配置项

Option	默认值	描述
symbol	"💧 "	The symbol used before displaying the version of Elixir/Erlang.
detect_extensions	[]	Which extensions should trigger this module.
detect_files	["mix.exs"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this modules.
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		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含一个 elm.json 文件
• 当前目录包含 elm-package.json 文件
• 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)"	组件格式化模板。
symbol	"🌳 "	A format string representing the symbol of Elm.
detect_extensions	["elm"]	Which extensions should trigger this module.
detect_files	["elm.json", "elm-package.json", ".elm-version"]	Which filenames should trigger this module.
detect_folders	["elm-stuff"]	Which folders should trigger this modules.
style	"cyan bold"	此组件的样式。
disabled	false	Disables the elm module.

Variables

字段	示例	描述
version	v0.19.1	The version of elm
symbol		symbol对应值
style*		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:

• 设置的 variable 是一个已存在的环境变量
• 未定义 variable，但定义了 default

配置项

Option	默认值	描述
symbol		这个字段的内容会显示在环境变量值之前。
variable		要显示的环境变量。
default		所选变量未定义时显示的默认值。
format	"with [$env_value]($style) "	组件格式化模板。
disabled	false	禁用 env_var 组件。

Variables

字段	示例	描述
env_value	Windows NT (if variable would be $OS)	The environment value of option variable
symbol		symbol对应值
style*	black bold dimmed	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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含一个 rebar.config 文件.
• 当前目录包含一个 erlang.mk 文件.

配置项

Option	默认值	描述
symbol	" "	The symbol used before displaying the version of erlang.
style	"bold red"	此组件的样式。
detect_extensions	[]	Which extensions should trigger this module.
detect_files	["rebar.config", "elang.mk"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this modules.
format	"via [$symbol($version )]($style)"	组件格式化模板。
disabled	false	Disables the erlang module.

Variables

字段	示例	描述
version	v22.1.3	The version of erlang
symbol		symbol对应值
style*		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.

配置项

Option	默认值	描述
format	'on [$symbol$account(\($region\))]($style) '	组件格式化模板。
symbol	"☁️ "	The symbol used before displaying the current GCP profile.
region_aliases		Table of region aliases to display in addition to the GCP name.
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		symbol对应值
style*		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	默认值	描述
always_show_remote	false	Shows the remote tracking branch name, even if it is equal to the local branch name.
format	"on [$symbol$branch]($style) "	组件格式化模板。 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 N graphemes.
truncation_symbol	"…"	此字段的内容用来表示分支名称被截断。 You can use "" for no symbol.
only_attached	false	Only show the branch name when not in a detached HEAD state.
disabled	false	禁用 git_branch 组件。

Variables

字段	示例	描述
branch	master	The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD).
remote_name	origin	The remote name.
remote_branch	master	The name of the branch tracked on remote_name.
symbol		symbol对应值
style*		style对应值

*: 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 and also the tag (if any) of the repo in your current directory.

配置项

Option	默认值	描述
commit_hash_length	7	显示的 git 提交哈希值的长度。
format	"[\\($hash\\)]($style) [\\($tag\\)]($style)"	组件格式化模板。
style	"bold green"	此组件的样式。
only_detached	true	Only show git commit hash when in detached HEAD state
tag_disabled	true	Disables showing tag info in git_commit module.
tag_symbol	"🏷 "	Tag symbol prefixing the info shown
disabled	false	禁用 git_commit 组件。

Variables

字段	示例	描述
hash	b703eb3	The current git commit hash
style*		style对应值

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

示例

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "

Git State

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

配置项

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)\) '	组件格式化模板。
disabled	false	禁用 git_state 模块

Variables

字段	示例	描述
state	REBASING	The current state of the repo
progress_current	1	The current operation progress
progress_total	2	The total operation progress
style*		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	"="	这个分支有合并冲突。
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	禁用 git_status 组件。

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*	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	显示相应的文件数量

示例

# ~/.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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含 go.mod 文件
• 当前目录包含 go.sum 文件
• 当前目录包含 glide.yaml 文件
• 当前目录包含 Gopkg.yml 文件
• 当前目录包含 Gopkg.lock 文件
• The current directory contains a .go-version file
• 当前目录包含 Godeps 目录
• 当前目录包含一个使用 .go 扩展名的文件

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"🐹 "	A format string representing the symbol of Go.
detect_extensions	["go"]	Which extensions should trigger this module.
detect_files	["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]	Which filenames should trigger this module.
detect_folders	["Godeps"]	Which folders should trigger this module.
style	"bold cyan"	此组件的样式。
disabled	false	Disables the golang module.

Variables

字段	示例	描述
version	v1.12.1	The version of go
symbol		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含一个 helmfile.yaml 文件
• The current directory contains a Chart.yaml file

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
detect_extensions	[]	Which extensions should trigger this module.
detect_files	["helmfile.yaml", "Chart.yaml"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this modules.
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		symbol对应值
style*		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	仅在连接到 SSH 会话时显示主机名。
trim_at	"."	当主机名过长被截断时，会截断成第一次匹配该字符串之前的主机名。 "." 会让主机名截断到第一个点处。 "" 会禁用任何截断。
format	"[$hostname]($style) in "	组件格式化模板。
style	"bold dimmed green"	此组件的样式。
disabled	false	禁用 hostname 组件。

Variables

字段	示例	描述
symbol		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, or build.boot file
• The current directory contains a file with the .java, .class, .gradle, .jar, .clj, or .cljc extension

配置项

Option	默认值	描述
format	"via [${symbol}(${version} )]($style)"	组件格式化模板。
detect_extensions	["java", "class", "gradle", "jar", "cljs", "cljc"]	Which extensions should trigger this module.
detect_files	["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this modules.
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		symbol对应值
style*		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.

::: warning

This module is not supported on tcsh.

:::

配置项

Option	默认值	描述
threshold	1	如果超过此字段的值，显示任务数量。
format	"[$symbol$number]($style) "	组件格式化模板。
symbol	"✦"	A format string representing the number of jobs.
style	"bold blue"	此组件的样式。
disabled	false	禁用 jobs 组件。

Variables

字段	示例	描述
number	1	The number of jobs
symbol		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• 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)"	组件格式化模板。
detect_extensions	["jl"]	Which extensions should trigger this module.
detect_files	["Project.toml", "Manifest.toml"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this modules.
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		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

[julia]
symbol = "∴ "

Kotlin

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

• The current directory contains a .kt or a .kts file

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
detect_extensions	["kt", "kts"]	Which extensions should trigger this module.
detect_files	[]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this modules.
symbol	"🅺 "	A format string representing the symbol of Kotlin.
style	"bold blue"	此组件的样式。
kotlin_binary	"kotlin"	Configures the kotlin binary that Starship executes when getting the version.
disabled	false	Disables the kotlin module.

Variables

字段	示例	描述
version	v1.4.21	The version of kotlin
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

[kotlin]
symbol = "🅺 "

# ~/.config/starship.toml

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

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace 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 '	组件格式化模板。
style	"cyan bold"	此组件的样式。
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		symbol对应值
style*		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	禁用 line_break 组件，使提示成为单行。

示例

# ~/.config/starship.toml

[line_break]
disabled = true

Lua

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

• The current directory contains a .lua-version file
• The current directory contains a lua directory
• The current directory contains a file with the .lua extension

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"🌙 "	A format string representing the symbol of Lua.
detect_extensions	["lua"]	Which extensions should trigger this module.
detect_files	[".lua-version"]	Which filenames should trigger this module.
detect_folders	["lua"]	Which folders should trigger this module.
style	"bold blue"	此组件的样式。
lua_binary	"lua"	Configures the lua binary that Starship executes when getting the version.
disabled	false	Disables the lua module.

Variables

字段	示例	描述
version	v5.4.0	The version of lua
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Memory Usage

The memory_usage module shows current system memory and swap usage.

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

::: tip

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

:::

配置项

Option	默认值	描述
threshold	75	隐藏内存使用情况，除非它超过这个百分比。
format	`"via $symbol [${ram}(	${swap})]($style) "`
symbol	"🐏"	这个字段的内容会显示在当前内存使用情况之前。
style	"bold dimmed white"	此组件的样式。
disabled	true	禁用 memory_usage 模块

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	🐏	symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Mercurial Branch

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

配置项

Option	默认值	描述
symbol	" "	该字段的内容显示于当前仓库的 hg 书签或活动分支名之前。
style	"bold purple"	此组件的样式。
format	"on [$symbol$branch]($style) "	组件格式化模板。
truncation_length	2^63 - 1	Truncates the hg branch name to N graphemes
truncation_symbol	"…"	此字段的内容用来表示分支名称被截断。
disabled	true	禁用 hg_branch 组件。

Variables

字段	示例	描述
branch	master	The active mercurial branch
symbol		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含一个 nim.cfg 文件
• 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.
detect_extensions	["nim", "nims", "nimble"]	Which extensions should trigger this module.
detect_files	["nim.cfg"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"bold yellow"	此组件的样式。
disabled	false	Disables the nim module.

Variables

字段	示例	描述
version	v1.2.0	The version of nimc
symbol		symbol对应值
style*		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) '	组件格式化模板。
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	禁用 nix_shell 组件。

Variables

字段	示例	描述
state	pure	The state of the nix-shell
name	lorri	The name of the nix-shell
symbol		symbol对应值
style*		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. By default the module will be shown if any of the following conditions are met:

• 当前目录包含 package.json 文件
• The current directory contains a .node-version file
• 当前目录包含 node_modules 目录
• 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)"	组件格式化模板。
symbol	" "	A format string representing the symbol of NodeJS.
detect_extensions	["js", "mjs", "cjs", "ts"]	Which extensions should trigger this module.
detect_files	["package.json", ".node-version"]	Which filenames should trigger this module.
detect_folders	["node_modules"]	Which folders should trigger this module.
style	"bold green"	此组件的样式。
disabled	false	Disables the nodejs module.
not_capable_style	bold red	The style for the module when an engines property in package.json does not match the NodeJS version.

Variables

字段	示例	描述
version	v13.12.0	The version of node
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

OCaml

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

• 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 )(\($switch_indicator$switch_name\) )]($style)"	The format string for the module.
symbol	"🐫 "	The symbol used before displaying the version of OCaml.
global_switch_indicator	""	The format string used to represent global OPAM switch.
local_switch_indicator	"*"	The format string used to represent local OPAM switch.
detect_extensions	["opam", "ml", "mli", "re", "rei"]	Which extensions should trigger this module.
detect_files	["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]	Which filenames should trigger this module.
detect_folders	["_opam", "esy.lock"]	Which folders should trigger this module.
style	"bold yellow"	此组件的样式。
disabled	false	Disables the ocaml module.

Variables

字段	示例	描述
version	v4.10.0	The version of ocaml
switch_name	my-project	The active OPAM switch
switch_indicator		Mirrors the value of indicator for currently active OPAM switch
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

OpenStack

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

配置项

Option	默认值	描述
format	"on [$symbol$cloud(\\($project\\))]($style) "	组件格式化模板。
symbol	"☁️ "	The symbol used before displaying the current OpenStack cloud.
style	"bold yellow"	此组件的样式。
disabled	false	Disables the openstack module.

Variables

字段	示例	描述
cloud	corp	The current OpenStack cloud
project	dev	The current OpenStack project
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Package Version

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

• npm —— npm 软件包版本从当前目录下的 package.json 中得到
• cargo —— cargo 软件包的版本从当前目录下的 Cargo.toml 中得到
• poetry —— poetry 软件包版本从当前目录下的 pyproject.toml 中得到
• composer —— composer 软件包版本从当前目录下的 composer.json 中得到
• 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
• meson - The meson package version is extracted from the meson.build present

⚠ 此组件显示的是源代码在当前目录中的软件包的版本，而不是包管理器的版本。

配置项

Option	默认值	描述
format	"is [$symbol$version]($style) "	组件格式化模板。
symbol	"📦 "	这个字段的内容会显示在当前软件包版本之前。
style	"bold 208"	此组件的样式。
display_private	false	Enable displaying version for packages marked as private.
disabled	false	禁用 package 组件。

Variables

字段	示例	描述
version	v1.0.0	The version of your package
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Perl

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

• 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

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	The format string for the module.
symbol	"🐪 "	The symbol used before displaying the version of Perl
detect_extensions	["pl", "pm", "pod"]	Which extensions should trigger this module.
detect_files	["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"bold 149"	此组件的样式。
disabled	false	Disables the perl module.

Variables

字段	示例	描述
version	v5.26.1	The version of perl
symbol		symbol对应值
style*		style对应值

示例

# ~/.config/starship.toml

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

PHP

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

• 当前目录包含一个 composer.json 文件
• The current directory contains a .php-version file
• The current directory contains a .php extension

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"🐘 "	这个字段的内容会显示在当前 PHP 版本之前。
detect_extensions	["php"]	Which extensions should trigger this module.
detect_files	["composer.json", ".php-version"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"147 bold"	此组件的样式。
disabled	false	Disables the php module.

Variables

字段	示例	描述
version	v7.3.8	The version of php
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

PureScript

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

• 当前目录包含一个 spago.dhall 文件
• The current directory contains a file with the .purs extension

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"<=> "	The symbol used before displaying the version of PureScript.
detect_extensions	["purs"]	Which extensions should trigger this module.
detect_files	["spago.dhall"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"bold white"	此组件的样式。
disabled	false	Disables the purescript module.

Variables

字段	示例	描述
version	0.13.5	The version of purescript
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Python

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

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

By default the module will be shown if any of the following conditions are met:

• 当前目录包含 .python-version 文件
• The current directory contains a Pipfile file
• The current directory contains a __init__.py file
• The current directory contains a pyproject.toml file
• The current directory contains a requirements.txt file
• The current directory contains a setup.py file
• The current directory contains a tox.ini file
• The current directory contains a file with the .py extension.
• 当前处于一个活跃的 python 虚拟环境中

配置项

Option	默认值	描述
format	'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'	组件格式化模板。
symbol	"🐍 "	用于表示Python的格式化字符串。
style	"yellow bold"	此组件的样式。
pyenv_version_name	false	使用 pyenv 获取 Python 版本
pyenv_prefix	pyenv	Prefix before pyenv version display, only used if pyenv is used
python_binary	["python", "python3, "python2"]	Configures the python binaries that Starship should executes when getting the version.
detect_extensions	[".py"]	Which extensions should trigger this module
detect_files	[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]	Which filenames should trigger this module
detect_folders	[]	Which folders should trigger this module
disabled	false	Disables the python module.

::: tip

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

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

:::

Variables

字段	示例	描述
version	"v3.8.1"	python版本
symbol	"🐍 "	symbol对应值
style	"yellow bold"	style对应值
pyenv_prefix	"pyenv "	Mirrors the value of option pyenv_prefix
virtualenv	"venv"	当前virtualenv名称

示例

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true

# ~/.config/starship.toml

[python]
# Only use the `python3` binary to get the version.
python_binary = "python3"

# ~/.config/starship.toml

[python]
# Don't trigger for files with the py extension
detect_extensions = []

Ruby

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

• 当前目录包含 Gemfile 文件
• The current directory contains a .ruby-version file
• 当前目录包含 .rb 文件

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"💎 "	A format string representing the symbol of Ruby.
detect_extensions	["rb"]	Which extensions should trigger this module.
detect_files	["Gemfile", ".ruby-version"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"bold red"	此组件的样式。
disabled	false	Disables the ruby module.

Variables

字段	示例	描述
version	v2.5.1	The version of ruby
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

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

• 当前目录包含 Cargo.toml 文件
• 当前目录包含一个使用 .rs 扩展名的文件

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"🦀 "	A format string representing the symbol of Rust
detect_extensions	["rs"]	Which extensions should trigger this module.
detect_files	["Cargo.toml"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"bold red"	此组件的样式。
disabled	false	Disables the rust module.

Variables

字段	示例	描述
version	v1.43.0-nightly	The version of rustc
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Scala

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

• The current directory contains a build.sbt, .scalaenv or .sbtenv file
• The current directory contains a file with the .scala or .sbt extension
• The current directory contains a directory named .metals

配置项

Option	默认值	描述
format	"via [${symbol}(${version} )]($style)"	组件格式化模板。
detect_extensions	["sbt", "scala"]	Which extensions should trigger this module.
detect_files	[".scalaenv", ".sbtenv", "build.sbt"]	Which filenames should trigger this module.
detect_folders	[".metals"]	Which folders should trigger this modules.
symbol	"🆂 "	A format string representing the symbol of Scala.
style	"red dimmed"	此组件的样式。
disabled	false	Disables the scala module.

Variables

字段	示例	描述
version	2.13.5	The version of scala
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

[scala]
symbol = "🌟 "

Shell

The shell module shows an indicator for currently used shell.

::: tip

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

:::

配置项

Option	默认值	描述
bash_indicator	bsh	A format string used to represent bash.
fish_indicator	fsh	A format string used to represent fish.
zsh_indicator	zsh	A format string used to represent zsh.
powershell_indicator	psh	A format string used to represent powershell.
ion_indicator	ion	A format string used to represent ion.
elvish_indicator	esh	A format string used to represent elvish.
tcsh_indicator	tsh	A format string used to represent tcsh.
format	$indicator	组件格式化模板。
disabled	true	Disables the shell module.

Variables

字段	默认值	描述
indicator		Mirrors the value of indicator for currently used shell.

Examples

# ~/.config/starship.toml

[shell]
fish_indicator = ""
powershell_indicator = "_"
disabled = false

SHLVL

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

配置项

Option	默认值	描述
threshold	2	Display threshold.
format	"[$symbol$shlvl]($style) "	组件格式化模板。
symbol	"↕️ "	The symbol used to represent the SHLVL.
repeat	false	Causes symbol to be repeated by the current SHLVL amount.
style	"bold yellow"	此组件的样式。
disabled	true	Disables the shlvl module.

Variables

字段	示例	描述
shlvl	3	The current value of SHLVL
symbol		symbol对应值
style*		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) '	组件格式化模板。
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		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

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.

:::

::: warning This module is not supported on elvish shell. :::

配置项

Option	默认值	描述
format	"[$symbol$status]($style) "	The format of the module
symbol	"✖"	The symbol displayed on program error
not_executable_symbol	"🚫"	The symbol displayed when file isn't executable
not_found_symbol	"🔍"	The symbol displayed when the command can't be found
sigint_symbol	"🧱"	The symbol displayed on SIGINT (Ctrl + c)
signal_symbol	"⚡"	The symbol displayed on any signal
style	"bold red"	此组件的样式。
recognize_signal_code	true	Enable signal mapping from exit code
map_symbol	false	Enable symbols mapping from exit code
disabled	true	Disables the status module.

Variables

字段	示例	描述
status	127	The exit code of the last command
int	127	The exit code of the last command
common_meaning	ERROR	Meaning of the code if not a signal
signal_number	9	Signal number corresponding to the exit code, only if signalled
signal_name	KILL	Name of the signal corresponding to the exit code, only if signalled
maybe_int	7	Contains the exit code number when no meaning has been found
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Swift

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

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

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"🐦 "	A format string representing the symbol of Swift
detect_extensions	["swift"]	Which extensions should trigger this module.
detect_files	["Package.swift"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"bold 202"	此组件的样式。
disabled	false	Disables the swift module.

Variables

字段	示例	描述
version	v5.2.4	The version of swift
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

Terraform

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

::: tip

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

:::

By default the module will be shown if any of the following conditions are met:

• The current directory contains a .terraform folder
• Current directory contains a file with the .tf or .hcl extensions

配置项

Option	默认值	描述
format	"via [$symbol$workspace]($style) "	The format string for the module.
symbol	"💠"	A format string shown before the terraform workspace.
detect_extensions	["tf", "hcl"]	Which extensions should trigger this module.
detect_files	[]	Which filenames should trigger this module.
detect_folders	[".terraform"]	Which folders should trigger this module.
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		symbol对应值
style*		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*		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 module will be shown if any of the following conditions are met:

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

::: tip

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

:::

配置项

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 "	组件格式化模板。
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

Vagrant

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

• The current directory contains a Vagrantfile file

配置项

Option	默认值	描述
format	"via [$symbol($version )]($style)"	组件格式化模板。
symbol	"⍱ "	A format string representing the symbol of Vagrant.
detect_extensions	[]	Which extensions should trigger this module.
detect_files	["Vagrantfile"]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.
style	"cyan bold"	此组件的样式。
disabled	false	Disables the vagrant module.

Variables

字段	示例	描述
version	Vagrant 2.2.10	The version of Vagrant
symbol		symbol对应值
style*		style对应值

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

示例

# ~/.config/starship.toml

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

VCSH

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

配置项

Option	默认值	描述
symbol		The symbol used before displaying the repository name.
style	"bold yellow"	此组件的样式。
format	"vcsh [$symbol$repo]($style) "	组件格式化模板。
disabled	false	Disables the vcsh module.

Variables

字段	示例	描述
repo	dotfiles if in a VCSH repo named dotfiles	The active repository name
symbol		symbol对应值
style*	black bold dimmed	style对应值

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

示例

# ~/.config/starship.toml

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

Zig

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

• 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)"	组件格式化模板。
disabled	false	Disables the zig module.
detect_extensions	["zig"]	Which extensions should trigger this module.
detect_files	[]	Which filenames should trigger this module.
detect_folders	[]	Which folders should trigger this module.

Variables

字段	示例	描述
version	v0.6.0	The version of zig
symbol		symbol对应值
style*		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)"	组件格式化模板。
disabled	false	Disables this custom module.

Variables

字段	描述
output	The output of shell command in shell
symbol	symbol对应值
style*	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", "-"]