starship/docs/ja-JP/config/README.md

設定

Starshipの設定を開始するには、~/.config/starship.toml ファイルを作成します。

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

Starshipのすべての設定は、このTOMLファイルで行われます。

# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'

# 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

設定ファイルの場所

STARSHIP_CONFIG 環境変数を使用することによって、デフォルトの設定ファイルの場所を変更できます。

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

PowerShell (Windows) で同様に $PROFILE にこの行を追加します。

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

または、Cmd (Windows) の場合、starship.luaにこの行を追加します。

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

ロギング

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 an instance of your terminal. しかし、これは STARSHIP_CACHE という環境変数を使って変更できます：

export STARSHIP_CACHE=~/.starship/cache

PowerShell (Windows) で同様に $PROFILEにこの行を追加します。

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

または、Cmd (Windows) の場合、starship.luaにこの行を追加します。

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

用語

モジュール: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 例えば、現在のディレクトリが Node.js のプロジェクトの場合、現在コンピュータにインストールされている Node.js のバージョンが表示されます。

変数: モジュールが提供する情報を含むサブコンポーネントを小さくする。 例えば、"nodejs" モジュールの "version" 変数には、Node.js の現在のバージョンが含まれています。

慣例により、ほとんどのモジュールにはデフォルトの端末色の接頭辞（"nodejs" の via など）と接尾辞として空のスペースがあります。

文字列

TOML記法では、文字列は'、"、'''、"""で宣言されます。

これらのStarship記法の記号は文字列のフォーマットにおいて特別な用途があり、文字として表示するためにはエスケープしなければなりません: $ [ ] ( ).

Symbol	Type	Notes
'	literal string	less escaping
"	string	more escaping
'''	multi-line literal string	less escaping
"""	multi-line string	more escaping, newlines in declarations can be ignored

例：

# literal string
format = '☺\☻ '

# regular string
format = "☺\\☻ "

# escaping Starship symbols
format = '\[\$\] '

When using line breaks, multi-line declarations can be used. For example, if you want to print a $ symbol on a new line, the following values for format are equivalent:

# with literal string
format = '''

\$'''

# with multiline basic string
format = """

\\$"""

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

In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.

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

文字列のフォーマット

文字列の書式は、モジュールがすべての変数を出力する書式です。 ほとんどのモジュールには、モジュールの表示形式を設定する format というエントリがあります。 テキスト、変数、およびテキストグループをフォーマット文字列で使用できます。

変数

変数には、 $ 記号と、その変数の名前が続きます。 変数の名前には英字と数字、_のみを含めることができます。

例：

• '$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.

テキストグループ

テキストグループは二つの異なる部分で構成されています。

[]で囲まれている最初の部分は、 フォーマット文字列 です。 テキスト、変数、または入れ子になったテキストグループを追加できます。

2 番目の部分は、 ()で囲まれている スタイル文字列 です。 これは、最初のフォーマット文字列のスタイルを設定するために使用できます。

例：

• '[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' sets green text on a blue background
• 'bg:blue fg:bright-green' sets bright green text on a blue background
• 'bold fg:27' sets bold text with ANSI color 27
• 'underline bg:#bf5700' sets underlined text on a burnt orange background
• 'bold italic fg:purple' sets bold italic purple text
• '' explicitly disables all styling

スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。 たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。 また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。

条件付きフォーマット設定

( と ) 内のすべての変数が空の場合、条件付き書式文字列はレンダリングされません。

例：

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

Negative matching

Many modules have detect_extensions, detect_files, and detect_folders variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of any negative indicator in the directory will result in the module not being matched.

Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, foo.bar.tar.gz will be matched against bar.tar.gz and gz in the detect_extensions variable. Files whose name begins with a dot are not considered to have extensions at all.

To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:

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

プロンプト

これは、プロンプト全体のオプションのリストです。

オプション

オプション	デフォルト	説明
format	link	プロンプトの形式を設定します。
right_format	''	右プロンプトの有効化を参照してください。
scan_timeout	30	ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。
command_timeout	500	Starshipによって実行されたコマンドのタイムアウト時間 (milliseconds) です。
add_newline	true	シェルプロンプトの間に空行を挿入します。
palette	''	Sets which color palette from palettes to use.
palettes	{}	Collection of color palettes that assign colors to user-defined names. Note that color palettes cannot reference their own color definitions.
follow_symlinks	true	Follows symlinks to check if they're directories; used in modules such as git.

::: tip

If you have symlinks to networked filesystems, consider setting follow_symlinks to false.

:::

設定例

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

# Set 'foo' as custom color palette
palette = 'foo'

# Define custom colors
[palettes.foo]
# Overwrite existing color
blue = '21'
# Define new color
mustard = '#af8700'

デフォルトのプロンプトフォーマット

デフォルトの format は、空または format が指定されていない場合、プロンプトのフォーマットを定義するために使用されます。 デフォルトは次のとおりです。

format = '$all'

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

デフォルトのフォーマットを拡張したいだけなら、$allを使用できます。 フォーマットに明示的に追加したモジュールは重複しません。 例:

# Move the directory to the second line
format = '$all$directory$character'

AWS

awsモジュールは、一時的な資格情報を使用する場合、現在のAWSリージョンとプロファイル、および有効期限タイマーを表示します。 モジュールの出力は、必要に応じてAWS_REGION、AWS_DEFAULT_REGIONとAWS_PROFILEの環境変数と、~/.aws/configと~/.aws/credentialsのファイルが使用されます。

The module will display a profile only if its credentials are present in ~/.aws/credentials or if a credential_process, sso_start_url, or sso_session are defined in ~/.aws/config. あるいは、環境変数にAWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEYまたはAWS_SESSION_TOKENのいずれかが定義されていれば条件を満たします。 もしforce_displayのオプションをtrueに設定した場合、上記の条件による資格情報が検出されない場合でも、利用可能なすべての情報が表示されます。

aws-vaultを使う場合、環境変数AWS_VAULTからプロファイルが、環境変数AWS_SESSION_EXPIRATIONから資格情報の有効期限が読み込まれます。

awsu を使う場合、そのプロファイルは環境変数 AWSU_PROFILE から読まれます。

AWSumeを使う場合、環境変数AWSUME_PROFILEからプロファイルが、環境変数AWSUME_EXPIRATIONから資格情報の有効期限が読み込まれます。

When using saml2aws the expiration information obtained from ~/.aws/credentials falls back to the x_security_token_expires key.

When using aws-sso-cli the profile is read from the AWS_SSO_PROFILE env var.

オプション

オプション	デフォルト	説明
format	'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'	module のフォーマットです。
symbol	'☁️ '	現在のAWSプロファイルを表示する前に表示される記号です。
region_aliases	{}	AWS名に加えて表示するリージョンのエイリアスです。
profile_aliases	{}	AWS名に加えて表示するプロファイルのエイリアスです。
style	'bold yellow'	モジュールのスタイルです。
expiration_symbol	'X'	この記号は一時的な資格情報が有効期限切れの場合に表示されます。
disabled	false	awsモジュールを無効にします。
force_display	false	trueの場合、credentials、credential_processまたはsso_start_urlが設定されていない場合でも情報を表示します。

変数

変数	設定例	説明
region	ap-northeast-1	現在のAWSリージョン
profile	astronauts	現在のAWSプロファイル
duration	2h27m20s	一時的な資格情報の有効期限
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

すべてを表示

# ~/.config/starship.toml

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

リージョンを表示

# ~/.config/starship.toml

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

プロファイルを表示

# ~/.config/starship.toml

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

Azure

azure モジュールは、現在のAzureサブスクリプションを表示します。 これは、 ~/.azure/azureProfile.json ファイルで定義されているデフォルトのサブスクリプション名またはユーザー名の表示に基づいています。

オプション

変数	デフォルト	説明
format	'on [$symbol($subscription)]($style) '	Azure module のフォーマットです。
symbol	'󰠅 '	フォーマットで使用される記号です。
style	'blue bold'	フォーマットで使用されるスタイルです。
disabled	true	azureモジュールを無効にします。
subscription_aliases	{}	Table of subscription name aliases to display in addition to Azure subscription name.

設定例

サブスクリプション名を表示

# ~/.config/starship.toml

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

ユーザー名を表示

# ~/.config/starship.toml

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

Display Subscription Name Alias

# ~/.config/starship.toml

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

バッテリー

batteryモジュールは、デバイスのバッテリー残量と現在の充電状態を示します。 モジュールは、デバイスのバッテリー残量が10％未満の場合にのみ表示されます。

オプション

オプション	デフォルト	説明
full_symbol	'󰁹 '	バッテリーが満タンのときに表示される記号です。
charging_symbol	'󰂄 '	バッテリーの充電中に表示される記号です。
discharging_symbol	'󰂃 '	バッテリーが放電しているときに表示される記号です。
unknown_symbol	'󰁽 '	バッテリー状態が不明なときに表示される記号です。
empty_symbol	'󰂎 '	バッテリーが空のときに表示される記号です。
format	'[$symbol$percentage]($style) '	module のフォーマットです。
display	link	モジュールの閾値とスタイルを表示します。
disabled	false	batteryモジュールを無効にします。

設定例

# ~/.config/starship.toml

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

バッテリーの表示

displayオプションを使用して、バッテリーインジケーターを表示するタイミング（threshold）、どのシンボルが使われるか(symbol) と外観（style）を定義します。 display が提供されない場合、 デフォルトは次のとおりです。

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

charging_symbolとdischarging_symbolオプションのデフォルト値はそれぞれbatteryの charging_symbolとdischarging_symbolになります。

オプション

displayオプションは、次の表の通りです。

オプション	デフォルト	説明
threshold	10	バッテリーが表示される上限です。
style	'red bold'	displayオプションが使用されている場合のスタイルです。
charging_symbol		displayオプションが使用されている場合はこののシンボルが表示されます。デフォルトはバッテリーの charging_symbol オプションと同じになります。
discharging_symbol		displayオプションが使用されている場合はこののシンボルが表示されます。デフォルトはバッテリーの discharging_symbol オプションと同じになります。

設定例

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

[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = 'bold yellow'
discharging_symbol = '💦 '

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

Buf

bufモジュールは、現在インストールされているBufのバージョンを表示します。 デフォルトでは次のすべての条件が満たされると、モジュールが表示されます。

• bufCLI がインストールされている
• カレントディレクトリに、buf.yaml、buf.gen.yamlまたはbuf.work.yamlが含まれている

オプション

オプション	デフォルト	説明
format	'with [$symbol($version )]($style)'	bufモジュールの形式。
version_format	'v${raw}'	バージョンのフォーマット。
symbol	'🐃 '	Bufのバージョンを表示する前に使用される記号です。
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold blue'	モジュールのスタイルです。
disabled	false	elixirモジュールを無効にします。

変数

変数	設定例	説明
version	v1.0.0	bufのバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[buf]
symbol = '🦬 '

Bun

The bun module shows the currently installed version of the bun JavaScript runtime. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにbun.lockbファイルが含まれている
• カレントディレクトリにbunfig.tomlファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🍞 '	A format string representing the symbol of Bun.
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['bun.lockb', 'bunfig.toml']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold red'	モジュールのスタイルです。
disabled	false	Disables the bun module.

変数

変数	設定例	説明
version	v0.1.4	The version of bun
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

C

c モジュールは、利用しているCコンパイラに関するいくつかの情報を表示します。 デフォルトでは、カレントディレクトリに.cまたは.hファイルが含まれている場合、モジュールが表示されます。

オプション

オプション	デフォルト	説明
format	'via [$symbol($version(-$name) )]($style)'	モジュールのフォーマット文字列。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'C '	コンパイラの詳細を表示する前に使用される記号です。
detect_extensions	['c', 'h']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
commands	[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]	コンパイラを検出する方法
style	'bold 149'	モジュールのスタイルです。
disabled	false	cモジュールを無効にします。

変数

変数	設定例	説明
name	clang	コンパイラ名
version	13.0.0	コンパイラのバージョン
symbol		オプション symbol の値をミラーする
style		オプション style の値をミラーする

versionはデフォルトのフォーマットではないことに注意してください。

Commands

commandsオプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。

Each command is represented as a list of the executable name, followed by its arguments, usually something like ['mycc', '--version']. StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。

もし、Cコンパイラがこのモジュールでサポートされていない場合は、GitHubで問題を提起することでリクエストできます。

設定例

# ~/.config/starship.toml

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

Character

characterモジュールは、端末でテキストが入力される場所の横に文字（通常は矢印）を表示します。

characterは、最後のコマンドが成功したかどうかを示します。 表し方は下記の2つです。

• 色の変更 (赤/緑)
• プロンプトの表示の変更 (❯/✖)

デフォルトでは、色だけが変更されます。 形も変えてみたい場合はこのサンプルも参考にしてください。

::: warning

vimcmd_symbolはcmd, fish and zshでのみサポートされています。 vimcmd_replace_one_symbol、vimcmd_replace_symbolとvimcmd_visual_symbolは、zshでのモード検出による問題のため、fishでのみサポートされています。

:::

オプション

オプション	デフォルト	説明
format	'$symbol '	テキスト入力の前に使用されるフォーマット文字列。
success_symbol	'[❯](bold green)'	前のコマンドが成功した場合にテキスト入力の前に使用されるフォーマット文字列です。
error_symbol	'[❯](bold red)'	前のコマンドが失敗した場合にテキスト入力の前に使用されるフォーマット文字列です。
vimcmd_symbol	'[❮](bold green)'	シェルがvimノーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列です。
vimcmd_replace_one_symbol	'[❮](bold purple)'	シェルがvimのreplace_oneモードの場合にテキスト入力の前に使用されるフォーマット文字列です。
vimcmd_replace_symbol	'[❮](bold purple)'	シェルがvimの置換モードの場合にテキスト入力の前に使用されるフォーマット文字列。
vimcmd_visual_symbol	'[❮](bold yellow)'	The format string used before the text input if the shell is in vim visual mode.
disabled	false	characterモジュールを無効にします。

変数

変数	設定例	説明
symbol		A mirror of either success_symbol, error_symbol, vimcmd_symbol or vimcmd_replace_one_symbol etc.

設定例

エラーの形状をカスタムする

# ~/.config/starship.toml

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

エラーの形状をカスタムしない

# ~/.config/starship.toml

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

vimの形状をカスタムする

# ~/.config/starship.toml

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

CMake

cmakeモジュールは、現在インストールされているCmakeのバージョンを表示します。 デフォルトでは次のいずれかの条件が満たされると、モジュールがアクティブになります。

• カレントディレクトリに CMakeLists.txt ファイルが含まれている
• カレントディレクトリに CMakeCache.txt ファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'△ '	cmakeのバージョンの前に使用される記号
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['CMakeLists.txt', 'CMakeCache.txt']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold blue'	モジュールのスタイルです。
disabled	false	cmakeモジュールを無効にします。

変数

変数	設定例	説明
version	v3.17.3	cmake のバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

COBOL / GNUCOBOL

COBOL モジュールは、現在インストールされているCOBOLのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに、.cobまたは.COBの拡張子のファイルが含まれている
• カレントディレクトリに、.cblまたは.CBLの拡張子のファイルが含まれている

オプション

オプション	デフォルト	説明
symbol	'⚙️ '	COBOLのバージョンを表示する前に使用される記号です。
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
style	'bold blue'	モジュールのスタイルです。
detect_extensions	['cbl', 'cob', 'CBL', 'COB']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	cobolモジュールを無効にします。

変数

変数	設定例	説明
version	v3.1.2.0	cobolのバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

Command Duration

cmd_durationモジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、またはmin_time値が存在する場合のみです。

::: warning BashでDEBUGトラップをhookしない

bashでStarshipを実行している場合、 eval $(starship init $0)実行した後にDEBUGトラップをフックしないでください。そうしないと、このモジュールがおそらくですが壊れます。

:::

preexecのような機能を必要とするBashユーザーは、 rcalorasのbash_preexecフレームワークを使用できます。 eval $(starship init $0) を実行する前に、preexec_functions、およびprecmd_functions定義するだけで、通常どおり続行します。

オプション

オプション	デフォルト	説明
min_time	2_000	実行時間を表示する最短期間（ミリ秒単位）です。
show_milliseconds	false	実行時間の秒に加えてミリ秒を表示します。
format	'took [$duration]($style) '	module のフォーマットです。
style	'bold yellow'	モジュールのスタイルです。
disabled	false	cmd_durationモジュールを無効にします。
show_notifications	false	コマンドが完了したらデスクトップ通知を表示します。
min_time_to_notify	45_000	通知を持続する最短期間 (ミリ秒単位) です。
notification_timeout		通知を表示する期間 (ミリ秒単位) です。 もし設定されていない場合、通知のタイムアウトはデーモンによって決定されます。 すべての通知デーモンがこのオプションを受け入れるわけではありません。

変数

変数	設定例	説明
duration	16m40s	コマンドの実行時間
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Conda

conda モジュールは、$CONDA_DEFAULT_ENV が設定されている場合、現在のConda 環境を表示します。

::: tip

Note: これはconda自身の プロンプト修飾子 を抑制しません。conda config --set changeps1 False で実行することができます。

:::

オプション

オプション	デフォルト	説明
truncation_length	1	環境がconda create -p [path]で作成された場合、環境パスが切り捨てられるディレクトリ数。 0は切り捨てがないことを意味します。 directoryもご覧ください。
symbol	'🅒 '	環境名の直前に使用されるシンボルです。
style	'bold green'	モジュールのスタイルです。
format	'via [$symbol$environment]($style) '	module のフォーマットです。
ignore_base	true	アクティブになった時、環境baseを無視します。
disabled	false	condaモジュールを無効にします。

変数

変数	設定例	説明
environment	astronauts	現在の conda 環境
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

コンテナ

containerモジュールは、コンテナ内の場合、シンボルとコンテナ名を表示します。

オプション

オプション	デフォルト	説明
symbol	'⬢'	コンテナ内にいる場合、このシンボルが表示されます。
style	'bold red dimmed'	モジュールのスタイルです。
format	'[$symbol \[$name\]]($style) '	module のフォーマットです。
disabled	false	containerモジュールを無効にします。

変数

変数	設定例	説明
name	fedora-toolbox:35	コンテナ名
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Crystal

crystalモジュールは、現在インストールされているCrystalのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにshard.ymlファイルが含まれている
• カレントディレクトリに.crの拡張子のファイルが含まれている

オプション

オプション	デフォルト	説明
symbol	'🔮 '	Crystalのバージョンを表示する前に使用される記号です。
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
style	'bold red'	モジュールのスタイルです。
detect_extensions	['cr']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['shard.yml']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	crystalモジュールを無効にします。

変数

変数	設定例	説明
version	v0.32.1	crystal のバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Daml

damlモジュールは、Damlプロジェクトのルートディレクトリにいるときに、使用しているDaml SDKバージョンを表示します。 環境変数DAML_SDK_VERSIONを上書きしない限り、daml.yamlファイルのsdk-versionが使用されます。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにdaml.yamlファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'Λ '	Damlの記号を表すフォーマット文字列です。
style	'bold cyan'	モジュールのスタイルです。
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['daml.yaml']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	damlモジュールを無効にします。

変数

変数	設定例	説明
version	v2.2.0	damlのバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Dart

dartモジュールは、現在インストールされているDartのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに.dartの拡張子のファイルが含まれている
• カレントディレクトリに.dart_toolディレクトリが含まれている
• カレントディレクトリにpubspec.yaml、pubspec.ymlまたはpubspec.lock が含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🎯 '	Dartのシンボルを表すフォーマット文字列
detect_extensions	['dart']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['.dart_tool']	どのフォルダーがこのモジュールをアクティブにするか
style	'bold blue'	モジュールのスタイルです。
disabled	false	dartモジュールを無効にします。

変数

変数	設定例	説明
version	v2.8.4	dart のバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Deno

denoモジュールは、現在インストールされているDenoのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにdeno.json、deno.jsonc、mod.ts、mod.js、deps.tsもしくはdeps.jsが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🦕 '	Dart のシンボルを表すフォーマット文字列
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'green bold'	モジュールのスタイルです。
disabled	false	denoモジュールを無効化します。

変数

変数	設定例	説明
version	v1.8.3	denoのバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

設定例

# ~/.config/starship.toml

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

Directory

directory モジュールは現在のディレクトリへのパスを表示します。親フォルダは3つまでに切り捨てられます。 git リポジトリ内にいる場合は、リポジトリのルートで切り捨てられます。

When using the fish_style_pwd_dir_length 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.

たとえば、~/Dev/Nix/nixpkgs/pkgsで、nixpkgs がリポジトリルートであり、オプションが 1 に設定されている場合を挙げます。 この場合、nixpkgs/pkgs の代わりに、~/D/N/nixpkgs/pkgs と表示されます。

オプション

オプション	デフォルト	説明
truncation_length	3	現在のディレクトリを切り捨てる親フォルダーの数です。
truncate_to_repo	true	現在いるgitリポジトリのルートに切り捨てるかどうかです。
format	'[$path]($style)[$read_only]($read_only_style) '	module のフォーマットです。
style	'bold cyan'	モジュールのスタイルです。
disabled	false	directoryモジュールを無効にします。
read_only	'🔒'	このシンボルが表示されている時、現在のディレクトリは読み取り専用です。
read_only_style	'red'	読み取り専用シンボルのスタイルです。
truncation_symbol	''	切り捨てられたパスの接頭辞として付けるシンボルです。 eg: '…/'
before_repo_root_style		The style for the path segment above the root of the git repo. デフォルトの値は style と同じです。
repo_root_style		gitリポジトリのルートのスタイルです。 デフォルトの値は style と同じです。
repo_root_format	'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '	The format of a git repo when before_repo_root_style and repo_root_style is defined.
home_symbol	'~'	ホームディレクトリを示すシンボルです。
use_os_path_sep	true	/を使用する代わりに、OS固有のパスの区切り文字を使用します。(例: Windowsの場合\)

このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。

Advanced Option	デフォルト	説明
substitutions		A table of substitutions to be made to the path.
fish_style_pwd_dir_length	0	fish shellのpwdパスロジックを適用するときに使用する文字数です。
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 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.

変数

変数	設定例	説明
path	'D:/Projects'	カレントディレクトリのパス
style*	'black bold dimmed'	オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

gitリポジトリは追加の変数があります。

/path/to/home/git_repo/src/libのパスについて考えます。

変数	設定例	説明
before_root_path	'/path/to/home/'	gitルートディレクトリパスの前のパス
repo_root	'git_repo'	gitルートディレクトリの名前
path	'/src/lib'	残りのパス
style	'black bold dimmed'	オプション style の値をミラーする
repo_root_style	'underline white'	gitルートディレクトリの名前のスタイル

設定例

# ~/.config/starship.toml

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

Direnv

The direnv module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by direnv.

オプション

オプション	デフォルト	説明
format	'[$symbol$loaded/$allowed]($style) '	module のフォーマットです。
symbol	'direnv '	The symbol used before displaying the direnv context.
style	'bold orange'	モジュールのスタイルです。
disabled	true	Disables the direnv module.
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['.envrc']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
allowed_msg	'allowed'	The message displayed when an rc file is allowed.
not_allowed_msg	'not allowed'	The message displayed when an rc file is not_allowed.
denied_msg	'denied'	The message displayed when an rc file is denied.
loaded_msg	'loaded'	The message displayed when an rc file is loaded.
unloaded_msg	'not loaded'	The message displayed when an rc file is not loaded.

変数

変数	設定例	説明
loaded	loaded	Whether the current rc file is loaded.
allowed	denied	Whether the current rc file is allowed.
rc_path	/home/test/.envrc	The current rc file path.
symbol		オプション symbol の値をミラーする.
style*	red bold	オプション style の値をミラーする.

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[direnv]
disabled = false

Docker Context

docker_contextモジュールは、defaultに設定されていない場合、または環境変数DOCKER_MACHINE_NAME、DOCKER_HOSTまたはDOCKER_CONTEXTが設定されている場合 (使用中のコンテキストを上書きするため)、現在アクティブなDocker contextを表示します。

オプション

オプション	デフォルト	説明
format	'via [$symbol$context]($style) '	module のフォーマットです。
symbol	'🐳 '	Dockerコンテキストを表示する前に使用される記号です。
only_with_files	true	ファイルに一致する場合にのみ表示
detect_extensions	[]	どの拡張子がこのモジュールをトリガーするか(only_with_filesがtrueになっている必要があります)。
detect_files	['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']	どんなファイル名がこのモジュールをトリガーするか(only_with_filesがtrueになっている必要があります)。
detect_folders	[]	どんなフォルダがこのモジュールをトリガーするか(only_with_filesがtrueになっている必要があります)。
style	'blue bold'	モジュールのスタイルです。
disabled	false	docker_contextモジュールを無効にします。

変数

変数	設定例	説明
context	test_context	現在の Docker コンテキスト
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Dotnet

dotnetモジュールはカレントディレクトリに関係する.NET Core SDKのバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。

デフォルトでは、このモジュールは現在のディレクトリに以下のファイルが 存在する場合にのみプロンプトで表示されます:

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

正しく使用するには、.NET Core SDKもインストールする必要があります。

内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 dotnet --version を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションでheuristic = false を設定します。

このモジュールは、カレントディレクトリに .csproj ファイルがある場合、Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks) も表示します。

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )(🎯 $tfm )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'.NET '	dotnetのバージョンを表示する前に使用される記号です。
heuristic	true	より高速なバージョン検出を使用して、starshipの動作を維持します。
detect_extensions	['csproj', 'fsproj', 'xproj']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold blue'	モジュールのスタイルです。
disabled	false	dotnetモジュールを無効にします。

変数

変数	設定例	説明
version	v3.1.201	dotnet sdk のバージョンです
tfm	netstandard2.0	現在のプロジェクトが対象としているターゲット フレームワーク モニカー
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Elixir

elixir モジュールは、現在インストールされているElixirとErlang/OTPのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにmix.exsファイルが含まれている.

オプション

オプション	デフォルト	説明
format	'via [$symbol($version \(OTP $otp_version\) )]($style)'	module elixirのフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'💧 '	Elixir/Erlangのバージョンを表示する前に使用される記号です。
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['mix.exs']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold purple'	モジュールのスタイルです。
disabled	false	elixirモジュールを無効にします。

変数

変数	設定例	説明
version	v1.10	elixirのバージョン
otp_version		elixirのotpバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[elixir]
symbol = '🔮 '

Elm

elmモジュールは、現在インストールされているElmのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにelm.jsonファイルが含まれている
• カレントディレクトリにelm-package.jsonファイルが含まれている
• カレントディレクトリに.elm-versionファイルが含まれている
• カレントディレクトリにelm-stuffフォルダが含まれている
• カレントディレクトリに*.elmファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🌳 '	Elmのシンボルを表すフォーマット文字列
detect_extensions	['elm']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['elm.json', 'elm-package.json', '.elm-version']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['elm-stuff']	どのフォルダーがこのモジュールをアクティブにするか
style	'cyan bold'	モジュールのスタイルです。
disabled	false	elmモジュールを無効にします。

変数

変数	設定例	説明
version	v0.19.1	elmのバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

環境変数

env_varモジュールは、選択された環境変数の現在の値を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。

• variableオプションが、既存の環境変数と一致する
• variableオプションが定義されておらず、defaultオプションが定義されている

::: tip

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

:::

::: tip

.を使うことで複数の環境変数を表示することができます。 (例を確認してみてください) variableが設定されていない場合、このモジュールは.以降に書かれている環境変数の値を表示します。

例: 次の設定ではUSER環境変数を表示します。

# ~/.config/starship.toml

[env_var.USER]
default = 'unknown user'

:::

オプション

オプション	デフォルト	説明
symbol	""	環境変数を表示する前に使用される記号です。
variable		表示される環境変数です。
default		上のvariableが定義されていない場合に表示されるデフォルトの値です。
format	"with [$env_value]($style) "	module のフォーマットです。
説明	"<env_var module>"	The description of the module that is shown when running starship explain.
disabled	false	env_varモジュールを無効にします。

変数

変数	設定例	説明
env_value	Windows NT (if variable would be $OS)	オプションvariableの値
symbol		オプション symbol の値をミラーする
style*	black bold dimmed	オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Displaying multiple environmental variables:

# ~/.config/starship.toml

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

Erlang

erlangモジュールは、現在インストールされているErlang/OTPのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにrebar.configファイルが含まれている.
• カレントディレクトリにerlang.mkファイルが含まれている.

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	' '	Erlangのバージョンを表示する前に使用される記号です。
style	'bold red'	モジュールのスタイルです。
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['rebar.config', 'elang.mk']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	erlangモジュールを無効にします。

変数

変数	設定例	説明
version	v22.1.3	erlang のバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Fennel

The fennel module shows the currently installed version of Fennel. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• The current directory contains a file with the .fnl extension

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🧅 '	The symbol used before displaying the version of fennel.
style	'bold green'	モジュールのスタイルです。
detect_extensions	['fnl']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	Disables the fennel module.

変数

変数	設定例	説明
version	v1.2.1	The version of fennel
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[fennel]
symbol = '⫰ '

Fill

fill モジュールは行の余分なスペースを記号で埋めます。 一行に複数のfillモジュールが存在する場合、それらはスペースを均等に分割します。 これは、他のモジュールの位置合わせに便利です。

オプション

オプション	デフォルト	説明
symbol	'.'	行を埋めるために使う記号
style	'bold black'	モジュールのスタイルです。
disabled	false	fillモジュールを無効にします。

設定例

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

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

このような出力になります:

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

Fossil Branch

The fossil_branch module shows the name of the active branch of the check-out in your current directory.

オプション

オプション	デフォルト	説明
format	'on [$symbol$branch]($style) '	module のフォーマットです。 Use '$branch' to refer to the current branch name.
symbol	' '	The symbol used before the branch name of the check-out in your current directory.
style	'bold purple'	モジュールのスタイルです。
truncation_length	2^63 - 1	Truncates a Fossil branch name to N graphemes
truncation_symbol	'…'	ブランチ名切り捨てられていることを示すための記号です。 You can use '' for no symbol.
disabled	true	Disables the fossil_branch module.

変数

変数	設定例	説明
branch	trunk	The active Fossil branch
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Fossil Metrics

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

オプション

オプション	デフォルト	説明
format	'([+$added]($added_style) )([-$deleted]($deleted_style) )'	module のフォーマットです。
added_style	'bold green'	The style for the added count.
deleted_style	'bold red'	The style for the deleted count.
only_nonzero_diffs	true	Render status only for changed items.
disabled	true	Disables the fossil_metrics module.

変数

変数	設定例	説明
added	1	The current number of added lines
deleted	2	The current number of deleted lines
added_style*		Mirrors the value of option added_style
deleted_style*		Mirrors the value of option deleted_style

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Google Cloud (gcloud)

gcloud モジュールは、 gcloud CLIの現在の設定が表示されます。 これは ~/.config/gcloud/active_config ファイルと ~/.config/gcloud/configurations/config_{CONFIG NAME} ファイルと CLOUDSDK_CONFIG 環境変数に基づきます。

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

オプション

オプション	デフォルト	説明
format	'on [$symbol$account(@$domain)(\($region\))]($style) '	module のフォーマットです。
symbol	'☁️ '	現在のGCPプロファイルを表示する前に表示される記号です。
region_aliases	{}	GCP名に加えて表示するリージョンのエイリアスです。
project_aliases	{}	GCP名に加えて表示するプロジェクトのエイリアスです。
detect_env_vars	[]	Which environmental variables should trigger this module
style	'bold blue'	モジュールのスタイルです。
disabled	false	gcloudモジュールを無効にします。

変数

変数	設定例	説明
region	us-central1	現在のGCPリージョン
account	foo	現在のGCPプロファイル
domain	example.com	現在のGCPプロファイルのドメイン
project		現在のGCPプロジェクト
active	default	~/.config/gcloud/active_config に書かれたアクティブな設定名
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

アカウントとプロジェクトを表示

# ~/.config/starship.toml

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

アクティブな設定名のみ表示

# ~/.config/starship.toml

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

アカウントとエイリアスされたリージョンを表示する

# ~/.config/starship.toml

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

アカウントとエイリアスされたプロジェクトを表示

# ~/.config/starship.toml

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

Git Branch

git_branchモジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。

オプション

オプション	デフォルト	説明
always_show_remote	false	ローカルブランチ名と等しい場合でも、リモート追跡ブランチ名を表示します。
format	'on [$symbol$branch(:$remote_branch)]($style) '	module のフォーマットです。 Use '$branch' to refer to the current branch name.
symbol	' '	gitブランチのシンボルを表すフォーマット文字列。
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.
ignore_branches	[]	表示しない名前のリスト。 Useful for 'master' or 'main'.
disabled	false	git_branchモジュールを無効にします。

変数

変数	設定例	説明
branch	master	現在のブランチがない場合は、現在のブランチ名はHEADに戻ります(例: git detached HEAD)
remote_name	origin	リモート名
remote_branch	master	remote_nameで追跡されたブランチ名
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Git コミット

git_commit モジュールは、カレントディレクトリのリポジトリの現在のコミットハッシュとタグ (もしあれば) を表示します。

オプション

オプション	デフォルト	説明
commit_hash_length	7	表示される git コミットハッシュの長さ。
format	'[\($hash$tag\)]($style) '	module のフォーマットです。
style	'bold green'	モジュールのスタイルです。
only_detached	true	detached HEAD 状態のときのみ git コミットハッシュを表示する
tag_disabled	true	git_commit モジュールのタグ情報の表示を無効にする。
tag_max_candidates	0	How many commits to consider for tag display. The default only allows exact matches.
tag_symbol	' 🏷 '	表示される情報の前に追加されるタグシンボル
disabled	false	git_commit モジュールを無効にします。

変数

変数	設定例	説明
hash	b703eb3	現在の git コミットハッシュ
tag	v1.0.0	The tag name if showing tag info is enabled.
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = '🔖 '

Git State

git_stateモジュールはgitディレクトリの進行状態を表します。 (例: REBASING, BISECTING, その他) 進行状況の情報がある場合は (例:REBASING 3/10)、その情報も表示されます。

オプション

オプション	デフォルト	説明
rebase	'REBASING'	rebase進行中に表示されるフォーマット文字列です。
merge	'MERGING'	merge進行中に表示されるフォーマット文字列です。
revert	'REVERTING'	revert進行中に表示されるフォーマット文字列です。
cherry_pick	'CHERRY-PICKING'	cherry-pick進行中に表示されるフォーマット文字列です。
bisect	'BISECTING'	bisect進行中に表示されるフォーマット文字列です。
am	'AM'	apply-mailbox (git am) 進行中に表示されるフォーマット文字列です。
am_or_rebase	'AM/REBASE'	あいまいなapply-mailboxまたはrebaseが進行中のときに表示されるフォーマット文字列です。
style	'bold yellow'	モジュールのスタイルです。
format	'\([$state( $progress_current/$progress_total)]($style)\) '	module のフォーマットです。
disabled	false	git_stateモジュールを無効にします。

変数

変数	設定例	説明
state	REBASING	現在のリポジトリの状態
progress_current	1	現在の進行状態
progress_total	2	全体の進行状態
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Git Metrics

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

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

:::

オプション

オプション	デフォルト	説明
added_style	'bold green'	The style for the added count.
deleted_style	'bold red'	The style for the deleted count.
only_nonzero_diffs	true	Render status only for changed items.
format	'([+$added]($added_style) )([-$deleted]($deleted_style) )'	module のフォーマットです。
disabled	true	Disables the git_metrics module.
ignore_submodules	false	Ignore changes to submodules

変数

変数	設定例	説明
added	1	The current number of added lines
deleted	2	The current number of deleted lines
added_style*		Mirrors the value of option added_style
deleted_style*		Mirrors the value of option deleted_style

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Git Status

git_status モジュールは、カレントディレクトリのリポジトリの状態を表すシンボルを表示します。

::: tip

WSL環境のWindowsディレクトリ(例: /mnt/c/以下) では、Git Statusモジュールは動作が非常に遅いです。 モジュールを無効にするか、windows_starshipオプションを使用することで、WindowsネイティブのStarshipを使用し、対象のgit_statusを計算できます。

:::

オプション

オプション	デフォルト	説明
format	'([\[$all_status$ahead_behind\]]($style) )'	git_status のデフォルトフォーマット
conflicted	'='	このブランチにはマージの競合があります。
ahead	'⇡'	aheadのフォーマット
behind	'⇣'	behindのフォーマット
diverged	'⇕'	divergedのフォーマット
up_to_date	''	up_to_dateのフォーマット
untracked	'?'	untrackedのフォーマット
stashed	'$'	stashedのフォーマット
modified	'!'	modifiedのフォーマット
staged	'+'	stagedのフォーマット
renamed	'»'	renamedのフォーマット
deleted	'✘'	deletedのフォーマット
typechanged	""	The format of typechange
style	'bold red'	モジュールのスタイルです。
ignore_submodules	false	サブモジュールの変更を無視します。
disabled	false	git_statusモジュールを無効にします。
windows_starship		WSLでWindowsディレクトリのgit_statusで使用するWindows Starshipの実行ファイルのLinux上でのパス。

変数

format 内では以下の変数が利用できます。

変数	説明
all_status	Shortcut for$conflicted$stashed$deleted$renamed$modified$staged$untracked
ahead_behind	Displays diverged, ahead, behind or up_to_date format string based on the current status of the repo.
conflicted	Displays conflicted when this branch has merge conflicts.
untracked	Displays untracked when there are untracked files in the working directory.
stashed	Displays stashed when a stash exists for the local repository.
modified	Displays modified when there are file modifications in the working directory.
staged	Displays staged when a new file has been added to the staging area.
renamed	Displays renamed when a renamed file has been added to the staging area.
deleted	Displays deleted when a file's deletion has been added to the staging area.
typechanged	Displays typechange when a file's type has been changed in the staging area.
style*	オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

The following variables can be used in diverged:

変数	説明
ahead_count	Number of commits ahead of the tracking branch
behind_count	Number of commits behind the tracking branch

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

変数	説明
count	ファイルの数を表示します。

設定例

# ~/.config/starship.toml

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

Show ahead/behind count of the branch being tracked

# ~/.config/starship.toml

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

Use Windows Starship executable on Windows paths in WSL

# ~/.config/starship.toml

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

Go

golangモジュールは、現在インストールされているGoのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにgo.modファイルが含まれている
• カレントディレクトリにgo.sumファイルが含まれている
• カレントディレクトリにgo.workファイルが含まれている
• カレントディレクトリにglide.yamlファイルが含まれている
• カレントディレクトリにGopkg.ymlファイルが含まれている
• カレントディレクトリにGopkg.lockファイルが含まれている
• カレントディレクトリに.go-versionファイルが含まれている
• カレントディレクトリにGodepsファイルが含まれている
• カレントディレクトリに.goの拡張子のファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🐹 '	A format string representing the symbol of Go.
detect_extensions	['go']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['Godeps']	どのフォルダーがこのモジュールをアクティブにするか
style	'bold cyan'	モジュールのスタイルです。
not_capable_style	'bold red'	The style for the module when the go directive in the go.mod file does not match the installed Go version.
disabled	false	golangモジュールを無効にします。

変数

変数	設定例	説明
version	v1.12.1	The version of go
mod_version	1.16	go version requirement as set in the go directive of go.mod. Will only show if the version requirement does not match the go version.
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Using mod_version

# ~/.config/starship.toml

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

Guix-shell

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

オプション

オプション	デフォルト	説明
format	'via [$symbol]($style) '	module のフォーマットです。
symbol	'🐃 '	A format string representing the symbol of guix-shell.
style	'yellow bold'	モジュールのスタイルです。
disabled	false	Disables the guix_shell module.

変数

変数	設定例	説明
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Gradle

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

デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• The current directory contains a gradle/wrapper/gradle-wrapper.properties directory.
• The current directory contains a file ending with .gradle or .gradle.kts.

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

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🅶 '	A format string representing the symbol of Gradle.
detect_extensions	['gradle', 'gradle.kts']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['gradle']	どのフォルダーがこのモジュールをアクティブにするか
style	'bold bright-cyan'	モジュールのスタイルです。
disabled	false	Disables the gradle module.
recursive	false	Enables recursive finding for the gradle directory.

変数

変数	設定例	説明
version	v7.5.1	The version of gradle
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

Haskell

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

デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにstack.yamlファイルが含まれている
• カレントディレクトリに.hs、.cabalまたは.hs-bootのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
symbol	'λ '	A format string representing the symbol of Haskell
detect_extensions	['hs', 'cabal', 'hs-boot']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['stack.yaml', 'cabal.project']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold purple'	モジュールのスタイルです。
disabled	false	Disables the haskell module.

変数

変数	設定例	説明
version		ghc_version or snapshot depending on whether the current project is a Stack project
snapshot	lts-18.12	Currently selected Stack snapshot
ghc_version	9.2.1	Currently installed GHC version
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

Haxe

The haxe module shows the currently installed version of Haxe. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• The current directory contains a project.xml, Project.xml, application.xml, haxelib.json, hxformat.json or .haxerc file
• The current directory contains a .haxelib or a haxe_libraries directory
• The current directory contains a file with the .hx or .hxml extension

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
detect_extensions	['hx', 'hxml']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['.haxelib', 'haxe_libraries']	どのフォルダーがこのモジュールをアクティブにするか
symbol	'⌘ '	A format string representing the symbol of Helm.
style	'bold fg:202'	モジュールのスタイルです。
disabled	false	Disables the haxe module.

変数

変数	設定例	説明
version	v4.2.5	The version of haxe
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Helm

helmモジュールは、現在インストールされているHelmのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにhelmfile.yamlファイルが含まれている
• カレントディレクトリにChart.yamlファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['helmfile.yaml', 'Chart.yaml']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
symbol	'⎈ '	A format string representing the symbol of Helm.
style	'bold white'	モジュールのスタイルです。
disabled	false	Disables the helm module.

変数

変数	設定例	説明
version	v3.1.1	The version of helm
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

ホスト名

hostnameモジュールには、システムのホスト名が表示されます。

オプション

オプション	デフォルト	説明
ssh_only	true	SSHセッションに接続されている場合にのみホスト名を表示します。
ssh_symbol	'🌐 '	A format string representing the symbol when connected to SSH session.
trim_at	'.'	この文字が最初にマッチするまでをホスト名と認識します。 '.' will stop after the first dot. '' will disable any truncation.
detect_env_vars	[]	Which environment variable(s) should trigger this module.
format	'[$ssh_symbol$hostname]($style) in '	module のフォーマットです。
style	'bold dimmed green'	モジュールのスタイルです。
disabled	false	hostnameモジュールを無効にします。

変数

変数	設定例	説明
hostname	computer	The hostname of the computer
style*		オプション style の値をミラーする
ssh_symbol	'🌏 '	The symbol to represent when connected to SSH session

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

Always show the hostname

# ~/.config/starship.toml

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

Hide the hostname in remote tmux sessions

# ~/.config/starship.toml

[hostname]
ssh_only = false
detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
disabled = false

Java

Javaモジュールは、現在インストールされているJavaのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, deps.edn, project.clj, build.boot, or .sdkmanrc file
• カレントディレクトリに拡張子が.java、.class、.gradle、.jar、.cljまたは.cljcのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [${symbol}(${version} )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
detect_extensions	['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
symbol	'☕ '	A format string representing the symbol of Java
style	'red dimmed'	モジュールのスタイルです。
disabled	false	javaモジュールを無効にします。

変数

変数	設定例	説明
version	v14	The version of java
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[java]
symbol = '🌟 '

ジョブ

jobsモジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.

The default functionality is:

• 0 jobs -> Nothing is shown.
• 1 job -> symbol is shown.
• 2 jobs or more -> symbol + number are shown.

::: warning

This module is not supported on tcsh and nu.

:::

::: warning

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

:::

オプション

オプション	デフォルト	説明
threshold*	1	超過した場合、ジョブの数を表示します。
symbol_threshold	1	Show symbol if the job count is at least symbol_threshold.
number_threshold	2	Show the number of jobs if the job count is at least number_threshold.
format	'[$symbol$number]($style) '	module のフォーマットです。
symbol	'✦'	The string used to represent the symbol variable.
style	'bold blue'	モジュールのスタイルです。
disabled	false	jobsモジュールを無効にします。

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

変数

変数	設定例	説明
number	1	ジョブの数
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Julia

juliaモジュールは、現在インストールされているJuliaのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにProject.tomlファイルが含まれている
• カレントディレクトリにManifest.tomlファイルが含まれている
• カレントディレクトリに.jlの拡張子のファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
detect_extensions	['jl']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['Project.toml', 'Manifest.toml']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
symbol	'ஃ '	Juliaのシンボルを表すフォーマット文字列
style	'bold purple'	モジュールのスタイルです。
disabled	false	juliaモジュールを無効にします。

変数

変数	設定例	説明
version	v1.4.0	juliaのバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[julia]
symbol = '∴ '

Kotlin

kotlinモジュールは、現在インストールされているKotlinのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに.ktもしくは.ktsファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
detect_extensions	['kt', 'kts']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
symbol	'🅺 '	Kotlinのシンボルを表すフォーマット文字列
style	'bold blue'	モジュールのスタイルです。
kotlin_binary	'kotlin'	Starshipがバージョンを取得するときに実行するkotlinバイナリを設定します。
disabled	false	kotlinモジュールを無効にします。

変数

変数	設定例	説明
version	v1.4.21	kotlinのバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[kotlin]
symbol = '🅺 '

# ~/.config/starship.toml

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

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-context --namespace astronaut. Similarly, the user and cluster can be set with kubectl config set-context starship-context --user starship-user and kubectl config set-context starship-context --cluster starship-cluster. 環境変数$KUBECONFIGが設定されている場合、このモジュールはそれを利用し、~/.kube/configを利用しません。

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

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

:::

オプション

::: warning

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

:::

オプション	デフォルト	説明
symbol	'☸ '	クラスター名の前に表示されるシンボルを表すフォーマット文字列。
format	'[$symbol$context( \($namespace\))]($style) in '	module のフォーマットです。
style	'cyan bold'	モジュールのスタイルです。
context_aliases*	{}	コンテキストの表示エイリアスを定義するテーブル。
user_aliases*	{}	Table of user aliases to display.
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
contexts	[]	Customized styles and symbols for specific contexts.
disabled	true	kubernetes モジュールを無効にする。

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

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

変数	説明
context_pattern	Required Regular expression to match current Kubernetes context name.
user_pattern	Regular expression to match current Kubernetes user name.
context_alias	Context alias to display instead of the full context name.
user_alias	User alias to display instead of the full user name.
style	The style for the module when using this context. If not set, will use module's style.
symbol	The symbol for the module when using this context. If not set, will use module's symbol.

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

変数

変数	設定例	説明
context	starship-context	The current kubernetes context name
namespace	starship-namespace	設定されている場合、現在の Kubernetes の namespace 名
user	starship-user	If set, the current kubernetes user
cluster	starship-cluster	If set, the current kubernetes cluster
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

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

# ~/.config/starship.toml

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

Kubernetes Context specific config

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

# ~/.config/starship.toml

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

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

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

Line Break

line_break モジュールは、プロンプトを2行に分割します。

オプション

オプション	デフォルト	説明
disabled	false	line_break モジュールを無効にして、プロンプトを1行にします。

設定例

# ~/.config/starship.toml

[line_break]
disabled = true

ローカルIP

localipモジュールは、プライマリネットワークインターフェイスのIPv4アドレスを表示します。

オプション

オプション	デフォルト	説明
ssh_only	true	SSHセッションに接続されている場合にのみ、IPアドレスを表示します。
format	'[$localipv4]($style) '	module のフォーマットです。
style	'bold yellow'	モジュールのスタイルです。
disabled	true	localipモジュールを無効にします。

変数

変数	設定例	説明
localipv4	192.168.1.13	プライマリIPv4アドレスが含まれています
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Lua

luaモジュールは、現在インストールされているLua のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに.lua-versionファイルが含まれている
• カレントディレクトリにluaディレクトリが含まれている
• カレントディレクトリに.luaの拡張子のファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🌙 '	Luaのシンボルを表すフォーマット文字列
detect_extensions	['lua']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['.lua-version']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['lua']	どのフォルダーがこのモジュールをアクティブにするか
style	'bold blue'	モジュールのスタイルです。
lua_binary	'lua'	Starshipがバージョンを取得するときに実行するLuaバイナリを設定します。
disabled	false	luaモジュールを無効にします。

変数

変数	設定例	説明
version	v5.4.0	lua のバージョン
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

メモリ使用量

memory_usage モジュールは、現在のシステムメモリとスワップ使用量を示します。

デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

:::

オプション

オプション	デフォルト	説明
threshold	75	この閾値を超えない限り、メモリ使用率は表示されません。
format	'via $symbol [${ram}( | ${swap})]($style) '	module のフォーマットです。
symbol	'🐏'	メモリ使用率を表示する前に使用される記号です。
style	'bold dimmed white'	モジュールのスタイルです。
disabled	true	memory_usageモジュールを無効にします。

変数

変数	設定例	説明
ram	31GiB/65GiB	The usage/total RAM of the current system memory.
ram_pct	48%	The percentage of the current system memory.
swap**	1GiB/4GiB	The swap memory size of the current system swap memory file.
swap_pct**	77%	The swap memory percentage of the current system swap memory file.
symbol	🐏	オプション symbol の値をミラーする
style*		オプション style の値をミラーする

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

設定例

# ~/.config/starship.toml

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

Meson

The meson module shows the current Meson developer environment status.

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

オプション

オプション	デフォルト	説明
truncation_length	2^32 - 1	Truncates a project name to N graphemes.
truncation_symbol	'…'	The symbol used to indicate a project name was truncated. You can use '' for no symbol.
format	'via [$symbol$project]($style) '	module のフォーマットです。
symbol	'⬢ '	The symbol used before displaying the project name.
style	'blue bold'	モジュールのスタイルです。
disabled	false	Disables the meson module.

変数

変数	設定例	説明
project	starship	The current Meson project name
symbol	🐏	オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Mercurial Branch

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

オプション

オプション	デフォルト	説明
symbol	' '	The symbol used before the hg bookmark or branch name of the repo in your current directory.
style	'bold purple'	モジュールのスタイルです。
format	'on [$symbol$branch(:$topic)]($style) '	module のフォーマットです。
truncation_length	2^63 - 1	Truncates the hg branch / topic name to N graphemes
truncation_symbol	'…'	ブランチ名切り捨てられていることを示すための記号です。
disabled	true	Disables the hg_branch module.

変数

変数	設定例	説明
branch	master	The active mercurial branch
topic	feature	The active mercurial topic
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Nim

nimモジュールは、現在インストールされているNimのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにnim.cfgファイルが含まれている
• カレントディレクトリに拡張子が.nimのファイルが含まれている
• カレントディレクトリに拡張子が.nimsのファイルが含まれている
• カレントディレクトリに拡張子が.nimbleのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	The format for the module
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'👑 '	The symbol used before displaying the version of Nim.
detect_extensions	['nim', 'nims', 'nimble']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['nim.cfg']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold yellow'	モジュールのスタイルです。
disabled	false	Disables the nim module.

変数

変数	設定例	説明
version	v1.2.0	The version of nimc
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Nix-shell

nix_shellモジュールはnix-shell環境を表示します。 このモジュールは、nixシェル環境内にあるときに表示されます。

オプション

オプション	デフォルト	説明
format	'via [$symbol$state( \($name\))]($style) '	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.
unknown_msg	''	A format string shown when it is unknown if the shell is pure/impure.
disabled	false	nix_shellモジュールを無効にします。
heuristic	false	Attempts to detect new nix shell-style shells with a heuristic.

変数

変数	設定例	説明
state	pure	The state of the nix-shell
name	lorri	The name of the nix-shell
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Node.js

nodejsモジュールは、現在インストールされているNode.jsのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにpackage.jsonファイルが含まれている
• カレントディレクトリに.node-versionファイルが含まれている
• カレントディレクトリに.nvmrcファイルが含まれている
• カレントディレクトリにnode_modulesディレクトリが含まれている
• カレントディレクトリに拡張子が.js、.mjsまたは.cjsのファイルが含まれている
• カレントディレクトリに拡張子が.ts、.mtsまたは.ctsのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	' '	A format string representing the symbol of Node.js.
detect_extensions	['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['package.json', '.node-version']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['node_modules']	どのフォルダーがこのモジュールをアクティブにするか
style	'bold green'	モジュールのスタイルです。
disabled	false	nodejsモジュールを無効にします。
not_capable_style	'bold red'	The style for the module when an engines property in package.json does not match the Node.js version.

変数

変数	設定例	説明
version	v13.12.0	The version of node
engines_version	>=12.0.0	node version requirement as set in the engines property of package.json. Will only show if the version requirement does not match the node version.
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

OCaml

ocamlモジュールは、現在インストールされているOCamlのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに拡張子.opamのファイルまたは_opamディレクトリが含まれている
• カレントディレクトリにesy.lockディレクトリが含まれている
• カレントディレクトリにduneまたはdune-projectファイルが含まれている
• カレントディレクトリにjbuildまたはjbuild-ignoreファイルが含まれている
• カレントディレクトリに.merlinファイルが含まれている
• カレントディレクトリに拡張子が.ml、.mli、.reまたは.reiのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'	モジュールのフォーマット文字列。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🐫 '	The symbol used before displaying the version of OCaml.
global_switch_indicator	''	The format string used to represent global OPAM switch.
local_switch_indicator	'*'	The format string used to represent local OPAM switch.
detect_extensions	['opam', 'ml', 'mli', 're', 'rei']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['_opam', 'esy.lock']	どのフォルダーがこのモジュールをアクティブにするか
style	'bold yellow'	モジュールのスタイルです。
disabled	false	Disables the ocaml module.

変数

変数	設定例	説明
version	v4.10.0	The version of ocaml
switch_name	my-project	The active OPAM switch
switch_indicator		Mirrors the value of indicator for currently active OPAM switch
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Open Policy Agent

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

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🪖 '	A format string representing the symbol of OPA.
detect_extensions	['rego']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold blue'	モジュールのスタイルです。
disabled	false	Disables the opa module.

変数

変数	設定例	説明
version	v0.44.0	The version of opa
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

OpenStack

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

オプション

オプション	デフォルト	説明
format	'on [$symbol$cloud(\($project\))]($style) '	module のフォーマットです。
symbol	'☁️ '	The symbol used before displaying the current OpenStack cloud.
style	'bold yellow'	モジュールのスタイルです。
disabled	false	Disables the openstack module.

変数

変数	設定例	説明
cloud	corp	The current OpenStack cloud
project	dev	The current OpenStack project
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

OS

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

::: warning

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

:::

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

:::

オプション

オプション	デフォルト	説明
format	'[$symbol]($style)'	module のフォーマットです。
style	'bold white'	モジュールのスタイルです。
disabled	true	Disables the os module.
symbols		A table that maps each operating system to its symbol.

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

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

変数

変数	設定例	説明
symbol	🎗️	The current operating system symbol from advanced option symbols
name	Arch Linux	The current operating system name
type	Arch	The current operating system type
codename		The current operating system codename, if applicable
edition		The current operating system edition, if applicable
version		The current operating system version, if applicable
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

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

パッケージのバージョン

package モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports npm, nimble, cargo, poetry, python, composer, gradle, julia, mix, helm, shards, daml and dart 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
• Nimble - The nimble package version is extracted from the *.nimble file present in the current directory with the nimble dump command
• Poetry – The poetry package version is extracted from the pyproject.toml present in the current directory
• Python - The python package version is extracted from a PEP 621 compliant pyproject.toml or a setup.cfg 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 in the current directory
• Julia - The package version is extracted from the Project.toml present in the current directory
• Mix - The mix package version is extracted from the mix.exs present in the current directory
• Helm - The helm chart version is extracted from the Chart.yaml present in the current directory
• Maven - The maven package version is extracted from the pom.xml present in the current directory
• Meson - The meson package version is extracted from the meson.build present in the current directory
• Shards - The shards package version is extracted from the shard.yml present in the current directory
• V - The vlang package version is extracted from the v.mod present in the current directory
• SBT - The sbt package version is extracted from the build.sbt present in the current directory
• Daml - The daml package version is extracted from the daml.yaml present in the current directory
• Dart - The dart package version is extracted from the pubspec.yaml present in the current directory

⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。

オプション

オプション	デフォルト	説明
format	'is [$symbol$version]($style) '	module のフォーマットです。
symbol	'📦 '	パッケージのバージョンを表示する前に使用される記号です。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
style	'bold 208'	モジュールのスタイルです。
display_private	false	Enable displaying version for packages marked as private.
disabled	false	package モジュールを無効にします。

変数

変数	設定例	説明
version	v1.0.0	The version of your package
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Perl

perlモジュールは、現在インストールされているPerlのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにMakefile.PLまたはBuild.PLファイルが含まれている
• カレントディレクトリにcpanfileまたはcpanfile.snapshotファイルが含まれている
• カレントディレクトリにMETA.jsonまたはMETA.ymlファイルが含まれている
• カレントディレクトリに.perl-versionファイルが含まれている
• カレントディレクトリに拡張子が.pl、.pmまたは.podのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	モジュールのフォーマット文字列。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🐪 '	The symbol used before displaying the version of Perl
detect_extensions	['pl', 'pm', 'pod']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold 149'	モジュールのスタイルです。
disabled	false	Disables the perl module.

変数

変数	設定例	説明
version	v5.26.1	The version of perl
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

設定例

# ~/.config/starship.toml

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

PHP

phpモジュールは、現在インストールされているPHP のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにcomposer.jsonファイルが含まれている
• カレントディレクトリに.php-versionファイルが含まれている
• カレントディレクトリに拡張子が.phpのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🐘 '	PHPのバージョンを表示する前に使用される記号です。
detect_extensions	['php']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['composer.json', '.php-version']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'147 bold'	モジュールのスタイルです。
disabled	false	phpモジュールを無効にします。

変数

変数	設定例	説明
version	v7.3.8	The version of php
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Pijul Channel

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

オプション

オプション	デフォルト	説明
symbol	' '	The symbol used before the pijul channel name of the repo in your current directory.
style	'bold purple'	モジュールのスタイルです。
format	'on [$symbol$channel]($style) '	module のフォーマットです。
truncation_length	2^63 - 1	Truncates the pijul channel name to N graphemes
truncation_symbol	'…'	ブランチ名切り捨てられていることを示すための記号です。
disabled	true	Disables the pijul module.

Pulumi

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

::: tip

By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). それでも有効にしたい場合は、 以下の例に従ってください.

:::

デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにPulumi.yamlまたはPulumi.ymlファイルが含まれている
• A parent directory contains either Pulumi.yaml or Pulumi.yml unless search_upwards is set to false

オプション

オプション	デフォルト	説明
format	'via [$symbol($username@)$stack]($style) '	モジュールのフォーマット文字列。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	' '	A format string shown before the Pulumi stack.
style	'bold 5'	モジュールのスタイルです。
search_upwards	true	Enable discovery of pulumi config files in parent directories.
disabled	false	Disables the pulumi module.

変数

変数	設定例	説明
version	v0.12.24	The version of pulumi
stack	dev	The current Pulumi stack
username	alice	The current Pulumi username
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

With Pulumi Version

# ~/.config/starship.toml

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

Without Pulumi version

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

PureScript

purescriptモジュールは、現在インストールされているPureScriptのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにspago.dhallファイルが含まれている
• カレントディレクトリに拡張子が.pursのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'<=> '	The symbol used before displaying the version of PureScript.
detect_extensions	['purs']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['spago.dhall']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold white'	モジュールのスタイルです。
disabled	false	Disables the purescript module.

変数

変数	設定例	説明
version	0.13.5	The version of purescript
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Python

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

pyenvversionname が true に設定されている場合 、pyenv でのバージョン名が表示されます 。 そうでなければ、python --version を元にバージョン番号を表示します。

デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに.python-versionファイルが含まれている
• カレントディレクトリにPipfileファイルが含まれている
• The current directory contains a __init__.py file
• カレントディレクトリにpyproject.tomlファイルが含まれている
• カレントディレクトリにrequirements.txtファイルが含まれている
• カレントディレクトリにsetup.pyファイルが含まれている
• カレントディレクトリにtox.iniファイルが含まれている
• カレントディレクトリに.pyの拡張子のファイルが含まれている.
• 仮想環境がアクティブである

オプション

オプション	デフォルト	説明
format	'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🐍 '	A format string representing the symbol of 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']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	pythonモジュールを無効にします。

::: tip

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

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

:::

変数

変数	設定例	説明
version	'v3.8.1'	The version of python
symbol	'🐍 '	オプション symbol の値をミラーする
style	'yellow bold'	オプション style の値をミラーする
pyenv_prefix	'pyenv '	Mirrors the value of option pyenv_prefix
virtualenv	'venv'	The current virtualenv name

設定例

# ~/.config/starship.toml

[python]
symbol = '👾 '
pyenv_version_name = true

# ~/.config/starship.toml

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

# ~/.config/starship.toml

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

# ~/.config/starship.toml

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

R

rlangモジュールは、現在インストールされているRのバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに拡張子が.Rのファイルが含まれている
• カレントディレクトリに拡張子が.Rdのファイルが含まれている
• カレントディレクトリに拡張子が.Rmdのファイルが含まれている
• カレントディレクトリに拡張子が.Rprojのファイルが含まれている
• カレントディレクトリに拡張子が.Rsxのファイルが含まれている
• カレントディレクトリに.Rprofileファイルが含まれている
• カレントディレクトリに.Rproj.userフォルダが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'📐'	A format string representing the symbol of R.
style	'blue bold'	モジュールのスタイルです。
detect_extensions	['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['.Rprofile']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['.Rproj.user']	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	Disables the r module.

変数

変数	設定例	説明
version	v4.0.5	The version of R
symbol		オプション symbol の値をミラーする
style	'blue bold'	オプション style の値をミラーする

設定例

# ~/.config/starship.toml

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

Raku

The raku module shows the currently installed version of Raku. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• The current directory contains a META6.json file
• The current directory contains a .p6, .pm6, .raku, .rakumod or .pod6

オプション

オプション	デフォルト	説明
format	'via [$symbol($version-$vm_version )]($style)'	モジュールのフォーマット文字列。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🦋 '	The symbol used before displaying the version of Raku
detect_extensions	['p6', 'pm6', 'pod6', 'raku', 'rakumod']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['META6.json']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold 149'	モジュールのスタイルです。
disabled	false	Disables the raku module.

変数

変数	設定例	説明
version	v6.d	The version of raku
vm_version	moar	The version of VM raku is built on
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

設定例

# ~/.config/starship.toml

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

Red

デフォルトではredモジュールは、現在インストールされているRedのバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:

• カレントディレクトリに拡張子が.red or .redsのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🔺 '	A format string representing the symbol of Red.
detect_extensions	['red']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'red bold'	モジュールのスタイルです。
disabled	false	Disables the red module.

変数

変数	設定例	説明
version	v2.5.1	The version of red
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[red]
symbol = '🔴 '

Ruby

デフォルトではrubyモジュールは現在インストールされているRubyのバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:

• カレントディレクトリにGemfileファイルが含まれている
• カレントディレクトリに .ruby-version ファイルが含まれている
• カレントディレクトリに .rb ファイルが含まれている
• 環境変数にRUBY_VERSIONまたはRBENV_VERSIONが設定されている

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

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'💎 '	Rubyのシンボルを表すフォーマット文字列.
detect_extensions	['rb']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['Gemfile', '.ruby-version']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
detect_variables	['RUBY_VERSION', 'RBENV_VERSION']	Which environment variables should trigger this module.
style	'bold red'	モジュールのスタイルです。
disabled	false	rubyモジュールを無効にします。

変数

変数	設定例	説明
version	v2.5.1	The version of ruby
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[ruby]
symbol = '🔺 '

Rust

デフォルトではrustモジュールは現在インストールされているRustのバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:

• カレントディレクトリにCargo.tomlファイルが含まれている
• カレントディレクトリに.rsの拡張子のファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🦀 '	Rustのシンボルを表すフォーマット文字列
detect_extensions	['rs']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['Cargo.toml']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold red'	モジュールのスタイルです。
disabled	false	rustモジュールを無効にします。

変数

変数	設定例	説明
version	v1.43.0-nightly	rustcのバージョン
numver	1.51.0	The numeric component of the rustc version
toolchain	beta	The toolchain version
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Scala

scala モジュールは、現在インストールされているScalaのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにbuild.sbt、.scalaenvまたは.sbtenvファイルが含まれている
• カレントディレクトリに拡張子が.scalaまたは.sbtのファイルが含まれている
• カレントディレクトリに.metalsディレクトリが含まれている

オプション

オプション	デフォルト	説明
format	'via [${symbol}(${version} )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
detect_extensions	['sbt', 'scala']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['.scalaenv', '.sbtenv', 'build.sbt']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['.metals']	どのフォルダーがこのモジュールをアクティブにするか
symbol	'🆂 '	A format string representing the symbol of Scala.
style	'red dimmed'	モジュールのスタイルです。
disabled	false	Disables the scala module.

変数

変数	設定例	説明
version	2.13.5	The version of scala
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[scala]
symbol = '🌟 '

Shell

The shell module shows an indicator for currently used shell.

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

:::

オプション

オプション	デフォルト	説明
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.
pwsh_indicator		A format string used to represent pwsh. The default value mirrors the value of powershell_indicator.
ion_indicator	'ion'	A format string used to represent ion.
elvish_indicator	'esh'	A format string used to represent elvish.
tcsh_indicator	'tsh'	A format string used to represent tcsh.
xonsh_indicator	'xsh'	A format string used to represent xonsh.
cmd_indicator	'cmd'	A format string used to represent cmd.
nu_indicator	'nu'	A format string used to represent nu.
unknown_indicator	''	The default value to be displayed when the shell is unknown.
format	'[$indicator]($style) '	module のフォーマットです。
style	'white bold'	モジュールのスタイルです。
disabled	true	Disables the shell module.

変数

変数	デフォルト	説明
indicator		Mirrors the value of indicator for currently used shell.
style*		オプション style の値をミラーする.

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

SHLVL

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

オプション

オプション	デフォルト	説明
threshold	2	Display threshold.
format	'[$symbol$shlvl]($style) '	module のフォーマットです。
symbol	'↕️ '	The symbol used to represent the SHLVL.
repeat	false	Causes symbol to be repeated by the current SHLVL amount.
repeat_offset	0	Decrements number of times symbol is repeated by the offset value
style	'bold yellow'	モジュールのスタイルです。
disabled	true	Disables the shlvl module.

変数

変数	設定例	説明
shlvl	3	The current value of SHLVL
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

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

# ~/.config/starship.toml

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

Singularity

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

オプション

オプション	デフォルト	説明
format	'[$symbol\[$env\]]($style) '	module のフォーマットです。
symbol	''	A format string displayed before the image name.
style	'bold dimmed blue'	モジュールのスタイルです。
disabled	false	Disables the singularity module.

変数

変数	設定例	説明
env	centos.img	The current Singularity image
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Solidity

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

• The current directory contains a file with the .sol extension

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${major}.${minor}.${patch}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'S '	A format string representing the symbol of Solidity
`compiler	['solc']	The default compiler for Solidity.
detect_extensions	['sol']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold blue'	モジュールのスタイルです。
disabled	false	Disables this module.

変数

変数	設定例	説明
version	v0.8.1	The version of solidity
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

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

Spack

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

オプション

オプション	デフォルト	説明
truncation_length	1	The number of directories the environment path should be truncated to. 0は切り捨てがないことを意味します。 directoryもご覧ください。
symbol	'🅢 '	環境名の直前に使用されるシンボルです。
style	'bold blue'	モジュールのスタイルです。
format	'via [$symbol$environment]($style) '	module のフォーマットです。
disabled	false	Disables the spack module.

変数

変数	設定例	説明
environment	astronauts	The current spack environment
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Status

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

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

:::

オプション

オプション	デフォルト	説明
format	'[$symbol$status]($style) '	The format of the module
symbol	'❌'	The symbol displayed on program error
success_symbol	''	The symbol displayed on program success
not_executable_symbol	'🚫'	The symbol displayed when file isn't executable
not_found_symbol	'🔍'	The symbol displayed when the command can't be found
sigint_symbol	'🧱'	The symbol displayed on SIGINT (Ctrl + c)
signal_symbol	'⚡'	The symbol displayed on any signal
style	'bold red'	モジュールのスタイルです。
recognize_signal_code	true	Enable signal mapping from exit code
map_symbol	false	Enable symbols mapping from exit code
pipestatus	false	Enable pipestatus reporting
pipestatus_separator	|	The symbol used to separate pipestatus segments (supports formatting)
pipestatus_format	'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'	The format of the module when the command is a pipeline
pipestatus_segment_format		When specified, replaces format when formatting pipestatus segments
disabled	true	Disables the status module.

変数

変数	設定例	説明
status	127	The exit code of the last command
hex_status	0x7F	The exit code of the last command in hex
int	127	The exit code of the last command
common_meaning	ERROR	Meaning of the code if not a signal
signal_number	9	Signal number corresponding to the exit code, only if signalled
signal_name	KILL	Name of the signal corresponding to the exit code, only if signalled
maybe_int	7	Contains the exit code number when no meaning has been found
pipestatus		Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Sudo

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

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

:::

オプション

オプション	デフォルト	説明
format	'[as $symbol]($style)'	The format of the module
symbol	'🧙 '	The symbol displayed when credentials are cached
style	'bold blue'	モジュールのスタイルです。
allow_windows	false	Since windows has no default sudo, default is disabled.
disabled	true	Disables the sudo module.

変数

変数	設定例	説明
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[sudo]
style = 'bold green'
symbol = '👩‍💻 '
disabled = false

# On windows
# $HOME\.starship\config.toml

[sudo]
allow_windows = true
disabled = false

Swift

デフォルトではswift モジュールは、現在インストールされているSwiftのバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:

• カレントディレクトリにPackage.swiftファイルが含まれている
• カレントディレクトリに拡張子が.swiftのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'🐦 '	A format string representing the symbol of Swift
detect_extensions	['swift']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['Package.swift']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'bold 202'	モジュールのスタイルです。
disabled	false	Disables the swift module.

変数

変数	設定例	説明
version	v5.2.4	The version of swift
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Terraform

terraform モジュールは、現在選択されているTerraform workspace とバージョンを表示します。

::: tip

Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 以下の例に従ってください.

:::

デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに.terraformフォルダが含まれている
• 現在のディレクトリに .tf, .tfplan または .tfstate のいずれかの拡張子を持つファイルがある。

オプション

オプション	デフォルト	説明
format	'via [$symbol$workspace]($style) '	モジュールのフォーマット文字列。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'💠'	ワークスペースの前に表示されるフォーマット文字列。
detect_extensions	['tf', 'tfplan', 'tfstate']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	['.terraform']	どのフォルダーがこのモジュールをアクティブにするか
style	'bold 105'	モジュールのスタイルです。
disabled	false	terraform モジュールを無効にします。

変数

変数	設定例	説明
version	v0.12.24	terraform のバージョン
workspace	default	現在のTerraformワークスペース
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

Terraform バージョン表示あり

# ~/.config/starship.toml

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

Terraform バージョン表示なし

# ~/.config/starship.toml

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

時刻

timeモジュールは、現在の現地時間を示します。 format設定は、時間の表示方法を制御するためにchronoクレートによって使用されます。 使用可能なオプションを確認するには、chrono strftimeのドキュメントをご覧ください。

::: tip

このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで disabled を false に設定します。

:::

オプション

オプション	デフォルト	説明
format	'at [$time]($style) '	モジュールのフォーマット文字列。
use_12hr	false	12時間のフォーマットを有効にします。
time_format	この表の下を参照してください	時刻のフォーマットに使用されるクロノフォーマット文字列 です。
style	'bold yellow'	モジュールのスタイルです。
utc_time_offset	'local'	使用するUTCオフセットを設定します。 Range from -24 < x < 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。
disabled	true	timeモジュールを無効にします。
time_range	'-'	Sets the time range during which the module will be shown. Times must be specified in 24-hours format

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

変数

変数	設定例	説明
time	13:08:10	The current time.
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Typst

The typst module shows the current installed version of Typst used in a project.

デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにtemplate.typファイルが含まれている
• The current directory contains any *.typ file

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	't '	Damlの記号を表すフォーマット文字列です。
style	'bold #0093A7'	モジュールのスタイルです。
detect_extensions	['.typ']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['template.typ']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
disabled	false	damlモジュールを無効にします。

変数

変数	設定例	説明
version	v0.9.0	The version of typst, alias for typst_version
typst_version	default	The current Typst version
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

ユーザー名

usernameモジュールはアクティブなユーザーのユーザー名を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:

• The current user is root/admin
• カレントユーザーが、ログインしているユーザーとは異なる
• ユーザーがSSHセッションとして接続されている
• show_always変数がtrueに設定されている

::: tip

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

:::

オプション

オプション	デフォルト	説明
style_root	'bold red'	The style used when the user is root/admin.
style_user	'bold yellow'	非rootユーザーに使用されるスタイルです。
format	'[$user]($style) in '	module のフォーマットです。
show_always	false	username モジュールを常に表示します。
disabled	false	username モジュールを無効にします。

変数

変数	設定例	説明
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

vagrantモジュールは、現在インストールされているVagrantのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリにVagrantfileファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'⍱ '	A format string representing the symbol of Vagrant.
detect_extensions	[]	どの拡張子がこのモジュールをアクティブにするか
detect_files	['Vagrantfile']	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'cyan bold'	モジュールのスタイルです。
disabled	false	Disables the vagrant module.

変数

変数	設定例	説明
version	Vagrant 2.2.10	The version of Vagrant
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

V

vlangモジュールは、現在インストールされているVのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。

• カレントディレクトリに拡張子が.vのファイルが含まれている
• カレントディレクトリにv.mod、vpkg.jsonまたは.vpkg-lock.jsonファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'V '	A format string representing the symbol of V
detect_extensions	['v']	どの拡張子がこのモジュールをアクティブにするか
detect_files	['v.mod', 'vpkg.json', '.vpkg-lock.json' ]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか
style	'blue bold'	モジュールのスタイルです。
disabled	false	Disables the vlang module.

変数

変数	設定例	説明
version	v0.2	The version of v
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

設定例

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

VCSH

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

オプション

オプション	デフォルト	説明
symbol	''	The symbol used before displaying the repository name.
style	'bold yellow'	モジュールのスタイルです。
format	'vcsh [$symbol$repo]($style) '	module のフォーマットです。
disabled	false	Disables the vcsh module.

変数

変数	設定例	説明
repo	dotfiles if in a VCSH repo named dotfiles	The active repository name
symbol		オプション symbol の値をミラーする
style*	black bold dimmed	オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

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

Zig

By default the zig module shows the currently installed version of Zig. 次の条件のいずれかが満たされると、モジュールが表示されます:

• カレントディレクトリに拡張子が.zigのファイルが含まれている

オプション

オプション	デフォルト	説明
format	'via [$symbol($version )]($style)'	module のフォーマットです。
version_format	'v${raw}'	バージョンのフォーマット。 使用可能な変数はraw、major、minorとpatchです。
symbol	'↯ '	The symbol used before displaying the version of Zig.
style	'bold yellow'	モジュールのスタイルです。
disabled	false	Disables the zig module.
detect_extensions	['zig']	どの拡張子がこのモジュールをアクティブにするか
detect_files	[]	どのファイル名がこのモジュールをアクティブにするか
detect_folders	[]	どのフォルダーがこのモジュールをアクティブにするか

変数

変数	設定例	説明
version	v0.6.0	The version of zig
symbol		オプション symbol の値をミラーする
style*		オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

設定例

# ~/.config/starship.toml

[zig]
symbol = '⚡️ '

Custom commands

The custom modules show the output of some arbitrary commands.

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

• The current directory contains a file whose name is in detect_files
• The current directory contains a directory whose name is in detect_folders
• The current directory contains a file whose extension is in detect_extensions
• The when command returns 0
• The current Operating System (std::env::consts::OS) matches with os field if defined.

::: tip

Multiple custom modules can be defined by using a ..

:::

::: tip

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

:::

::: tip

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

:::

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

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

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

:::

オプション

オプション	デフォルト	説明
command	''	The command whose output should be printed. The command will be passed on stdin to the shell.
when	false	Either a boolean value (true or false, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a 0 status code.
require_repo	false	If true, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options.
shell		この表の下を参照してください
説明	'<custom module>'	The description of the module that is shown when running starship explain.
detect_files	[]	The files that will be searched in the working directory for a match.
detect_folders	[]	The directories that will be searched in the working directory for a match.
detect_extensions	[]	The extensions that will be searched in the working directory for a match.
symbol	''	The symbol used before displaying the command output.
style	'bold green'	モジュールのスタイルです。
format	'[$symbol($output )]($style)'	module のフォーマットです。
disabled	false	Disables this custom module.
os		Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values.
use_stdin		An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling.
ignore_timeout	false	Ignore global command_timeout setting and keep running external commands, no matter how long they take.

変数

変数	説明
output	The output of shell command in shell
symbol	オプション symbol の値をミラーする
style*	オプション style の値をミラーする

*: この変数は、スタイル文字列の一部としてのみ使用することができます。

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

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

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

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

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

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

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

:::

設定例

# ~/.config/starship.toml

[custom.foo]
command = 'echo foo' # shows output of command
detect_files = ['foo'] # can specify filters but wildcards are not supported
when = ''' test "$HOME" = "$PWD" '''
format = ' transcending [$output]($style)'

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

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