starship/docs/zh-TW/config/README.md

設定

為了開始設定 Starship，請建立下右檔案： ~/.config/starship.toml.

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

所有關於 Starship 的設定都在這個 TOML 檔案內：

# 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

你可以藉由修改 STARSHIP_CONFIG環境變數而改變預設的starship.toml 檔案位置

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"

術語

模組 (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" 設定具有 ANSI 顏色 27 號的粗體文字
• "underline bg:#bf5700" 在一個燒橙色背景上設定有底線的文字
• "bold italic fg:purple" 設定粗體、斜體且紫色的文字
• "" 明確地關閉所有風格

注意風格產出的樣子取決於你的終端機模擬器。 例如，有些終端機模擬器會提升顏色的亮度而不是讓文字變粗體，而且有些色彩主題對一般與加亮顏色使用的是相同色碼。 除此之外，為了要有斜體字，你的終端機一定要支援斜體。

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	Timeout for starship to scan files (in milliseconds).
add_newline	true	在提示字元前面加上換行字元。

範例

# ~/.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. 預設如下：

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\
$kotlin\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$ruby\
$rust\
$swift\
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$custom\
$cmd_duration\
$line_break\
$lua\
$jobs\
$battery\
$time\
$status\
$character"""

AWS

aws 模組顯示現在 AWS 的區域與概況。 這是根據 AWS_REGION、AWS_DEFAULT_REGION 與 AWS_PROFILE 環境變數及 ~/.aws/config 檔案。

從 AWS_VAULT讀取而使用 aws-vault 這個設定檔

選項

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 = "🅰 "

電池

battery 模組顯示電池的電量以及現在的充電狀態。 這個模組只會在裝置的電量低於 10% 的時候看見。

選項

Option	預設	說明
full_symbol	""	當電池充飽時顯示的符號。
charging_symbol	""	當電池正在充電時顯示的符號。
discharging_symbol	""	當電池正在放電時顯示的符號。
unknown_symbol	""	The symbol shown when the battery state is unknown.
empty_symbol	""	The symbol shown when the battery state is empty.
format	"[$symbol$percentage]($style) "	The format for the module.
display	連結	Display threshold and style for the module.
disabled	false	Disables the battery module.

範例

# ~/.config/starship.toml

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

電池顯示

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	The upper bound for the display option.
style	The style used if the display option is in use.

範例

[[battery.display]]  # 0% 到 10% 電量之間時，使用 "bold red" 風格
threshold = 10
style = "bold red"

[[battery.display]]  # 10% 到 30% 電量之間時，使用 "bold yellow" 風格
threshold = 30
style = "bold yellow"

# 當電量超過 30% 時，電量指示就不會顯示出來

字元

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	Disables the character module.

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 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) "	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	Shortest duration to show time for (in milliseconds).
show_milliseconds	false	Show milliseconds in addition to seconds for the duration.
format	"took [$duration]($style) "	The format for the module.
style	"bold yellow"	這個模組的風格。
disabled	false	Disables the cmd_duration module.
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*		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)"

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	The number of directories the environment path should be truncated to, if the environment was created via conda create -p [path]. 0 means no truncation. Also see the directory module.
symbol	"🅒 "	The symbol used before the environment name.
style	"bold green"	這個模組的風格。
format	"via [$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	"🔮 "	The symbol used before displaying the version of crystal.
style	"bold red"	這個模組的風格。
format	"via [$symbol$version]($style) "	The format for the module.
disabled	false	Disables the crystal module.

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

選項

Option	預設	說明
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) "

資料夾

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	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)[$read_only]($read_only_style) "	The format for the module.
style	"bold cyan"	這個模組的風格。
disabled	false	Disables the directory module.
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: "…/"

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	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.

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"	Mirrors the value of option 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) "	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	"[$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. 這個模組在下列其中一個條件達成時顯示：

• 現在資料夾中包含一個 mix.exs 檔案.

選項

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. 這個模組在下列其中一個條件達成時顯示：

• 現在資料夾中包含一個 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) "	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) "

環境變數

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		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. 這個模組在下列其中一個條件達成時顯示：

• 現在資料夾中包含一個 rebar.config 檔案.
• 現在資料夾中包含一個 erlang.mk 檔案.

選項

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.

選項

Option	預設	說明
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 分支

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) "	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.
only_attached	false	Only show the branch name when not in a detached HEAD state.
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).
remote_name	origin	The remote name.
remote_branch	master	The name of the branch tracked on remote_name.
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 and also the tag (if any) of the repo in your current directory.

選項

Option	預設	說明
commit_hash_length	7	The length of the displayed git commit hash.
format	"[\\($hash\\)]($style) [\\($tag\\)]($style)"	The format for the module.
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	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
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)\) '	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. 這個模組在下列其中一個條件達成時顯示：

• 現在資料夾中含有一個 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) "	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. 這個模組在下列其中一個條件達成時顯示：

• 現在資料夾中包含一個 helmfile.yaml 檔案
• 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) "

主機名稱

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, .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) "	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 = "🌟 "

工作

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 = "∴ "

Kotlin

The kotlin module shows the currently installed version of Kotlin. 這個模組在下列其中一個條件達成時顯示：

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

選項

Option	預設	說明
format	"via [$symbol$version]($style) "	The format for the module.
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		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

[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 '	The format for the module.
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		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

Lua

The lua module shows the currently installed version of Lua. 這個模組在下列其中一個條件達成時顯示：

• 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) "	The format for the module.
symbol	"🌙 "	A format string representing the symbol of Lua.
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		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

[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	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
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	" "	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.
not_capable_style	bold red	The style for the module when an engines property in Packages.json does not match the NodeJS version.

 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) "

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) "

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) "	The format for the module.
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		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

[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 – 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
• meson - The meson package version is extracted from the meson.build 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) "

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

選項

Option	預設	說明
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) "

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)"

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.
python_binary	["python", "python3, "python2"]	Configures the python binaries that Starship should executes when getting the version.
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"	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

範例

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

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.

選項

Option	預設	說明
threshold	2	Display threshold.
format	"[$symbol$shlvl]($style) "	The format for the module.
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		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) '

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. :::

選項

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		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_common_meaning$status_signal_name$status_maybe_int\]]($style) '
map_symbol = true
disabled = false

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)"

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 or .hcl extensions

選項

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) "

時間

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

::: 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 "	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", "-"]