starship/docs/ja-JP/config
2023-02-01 01:14:38 +09:00
..
README.md docs(i18n): new Crowdin updates (#4719) 2023-02-01 01:14:38 +09:00

蚭定

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

Config File Location

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

ロギング

デフォルトでは、Starship は譊告や゚ラヌログを ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log ずいう名前のファむルに出力したす。このセッションキヌはタヌミナルのむンスタンスに盞圓したす。 しかし、これは 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 などず接尟蟞ずしお空のスペヌスがありたす。

Strings

In TOML syntax, text values are declared with ', ", ''', or """.

The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: $ [ ] ( ).

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.

蚭定䟋

# ~/.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\
$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\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$buf\
$nix_shell\
$conda\
$meson\
$spack\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$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のファむルが䜿甚されたす。

モゞュヌルは、資栌情報が~/.aws/credentialsにある堎合、たたは~/.aws/configにcredential_processたたはsso_start_urlが定矩されおいる堎合にのみプロファむルを衚瀺したす。 あるいは、環境倉数に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.

オプション

オプション デフォルト 説明
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モゞュヌルを無効にしたす。

蚭定䟋

サブスクリプション名を衚瀺

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

バッテリヌ

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]
vicmd_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 リポゞトリ内にいる堎合は、リポゞトリのルヌトで切り捚おられたす。

fish スタむルの pwd オプションを䜿甚しおいる堎合、切り捚おられたパスを非衚瀺にする代わりに、オプションで有効にした数倀に基づいた各ディレクトリの短瞮名が衚瀺されたす。

たずえば、~/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 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 = '
/'

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 のフォヌマットです。
description "<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 '
' The symbol used to indicate a branch name was truncated. 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 = ''

Google Cloud (gcloud)

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

オプション

オプション デフォルト 説明
format 'on [$symbol$account(@$domain)(\($region\))]($style) ' module のフォヌマットです。
symbol '☁ ' The symbol used before displaying the current GCP profile.
region_aliases {} Table of region aliases to display in addition to the GCP name.
project_aliases {} Table of project aliases to display in addition to the GCP name.
style 'bold blue' モゞュヌルのスタむルです。
disabled false Disables the gcloud module.

倉数

倉数 蚭定䟋 説明
region us-central1 The current GCP region
account foo The current GCP profile
domain example.com The current GCP profile domain
project The current GCP project
active default The active config name written in ~/.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

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

オプション

オプション デフォルト 説明
always_show_remote false Shows the remote tracking branch name, even if it is equal to the local branch name.
format 'on [$symbol$branch(:$remote_branch)]($style) ' module のフォヌマットです。 Use '$branch' to refer to the current branch name.
symbol ' ' A format string representing the symbol of git branch.
style 'bold purple' モゞュヌルのスタむルです。
truncation_length 2^63 - 1 Truncates a git branch to N graphemes.
truncation_symbol '
' The symbol used to indicate a branch name was truncated. You can use '' for no symbol.
only_attached false Only show the branch name when not in a detached HEAD state.
ignore_branches [] A list of names to avoid displaying. Useful for 'master' or 'main'.
disabled false Disables the git_branch module.

倉数

倉数 蚭定䟋 説明
branch master The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD).
remote_name origin The remote name.
remote_branch master The name of the branch tracked on remote_name.
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

Git コミット

The git_commit module shows the current commit hash and also the tag (if any) of the repo in your current directory.

オプション

オプション デフォルト 説明
commit_hash_length 7 The length of the displayed git commit hash.
format '[\($hash$tag\)]($style) ' module のフォヌマットです。
style 'bold green' モゞュヌルのスタむルです。
only_detached true Only show git commit hash when in detached HEAD state
tag_disabled true Disables showing tag info in git_commit module.
tag_max_candidates 0 How many commits to consider for tag display. The default only allows exact matches.
tag_symbol ' 🏷 ' Tag symbol prefixing the info shown
disabled false Disables the git_commit module.

倉数

倉数 蚭定䟋 説明
hash b703eb3 The current git commit hash
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

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

オプション

オプション デフォルト 説明
rebase 'REBASING' A format string displayed when a rebase is in progress.
merge 'MERGING' A format string displayed when a merge is in progress.
revert 'REVERTING' A format string displayed when a revert is in progress.
cherry_pick 'CHERRY-PICKING' A format string displayed when a cherry-pick is in progress.
bisect 'BISECTING' A format string displayed when a bisect is in progress.
am 'AM' A format string displayed when an apply-mailbox (git am) is in progress.
am_or_rebase 'AM/REBASE' A format string displayed when an ambiguous apply-mailbox or rebase is in progress.
style 'bold yellow' モゞュヌルのスタむルです。
format '\([$state( $progress_current/$progress_total)]($style)\) ' module のフォヌマットです。
disabled false Disables the git_state module.

倉数

倉数 蚭定䟋 説明
state REBASING The current state of the repo
progress_current 1 The current operation progress
progress_total 2 The total operation progress
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

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

:::

オプション

オプション デフォルト 説明
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.

倉数

倉数 蚭定䟋 説明
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

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

::: tip

The Git Status module is very slow in Windows directories (for example under /mnt/c/) when in a WSL environment. You can disable the module or use the windows_starship option to use a Windows-native Starship executable to compute git_status for those paths.

:::

オプション

オプション デフォルト 説明
format '([\[$all_status$ahead_behind\]]($style) )' The default format for git_status
conflicted '=' This branch has merge conflicts.
ahead '⇡' The format of ahead
behind '⇣' The format of behind
diverged '⇕' The format of diverged
up_to_date '' The format of up_to_date
untracked '?' The format of untracked
stashed '$' The format of stashed
modified '!' The format of modified
staged '+' The format of staged
renamed '»' The format of renamed
deleted '✘' The format of deleted
style 'bold red' モゞュヌルのスタむルです。
ignore_submodules false Ignore changes to submodules.
disabled false Disables the git_status module.
windows_starship Use this (Linux) path to a Windows Starship executable to render git_status when on Windows paths in WSL.

倉数

The following variables can be used in 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.
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 Show the number of files

蚭定䟋

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

The golang module shows the currently installed version of 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' モゞュヌルのスタむルです。
disabled false Disables the golang module.

倉数

倉数 蚭定䟋 説明
version v1.12.1 The version of go
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

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

The helm module shows the currently installed version of 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) '

ホスト名

The hostname module shows the system hostname.

オプション

オプション デフォルト 説明
ssh_only true Only show hostname when connected to an SSH session.
ssh_symbol '🌐 ' A format string representing the symbol when connected to SSH session.
trim_at '.' String that the hostname is cut off at, after the first match. '.' will stop after the first dot. '' will disable any truncation
format '[$ssh_symbol$hostname]($style) in ' module のフォヌマットです。
style 'bold dimmed green' モゞュヌルのスタむルです。
disabled false Disables the hostname module.

倉数

倉数 蚭定䟋 説明
hostname computer The hostname of the computer
style* オプション style の倀をミラヌする
ssh_symbol '🌏 ' The symbol to represent when connected to SSH session

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

Java

The java module shows the currently installed version of Java. デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, deps.edn, project.clj, or build.boot file
  • カレントディレクトリに拡匵子が.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'] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders [] どのフォルダヌがこのモゞュヌルをアクティブにするか
symbol '☕ ' A format string representing the symbol of Java
style 'red dimmed' モゞュヌルのスタむルです。
disabled false Disables the java module.

倉数

倉数 蚭定䟋 説明
version v14 The version of java
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

[java]
symbol = '🌟 '

Jobs

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there 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 Show number of jobs if exceeded.
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 Disables the jobs module.

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

倉数

倉数 蚭定䟋 説明
number 1 The number of jobs
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

Julia

The julia module shows the currently installed version of 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 'ஃ ' A format string representing the symbol of Julia.
style 'bold purple' モゞュヌルのスタむルです。
disabled false Disables the julia module.

倉数

倉数 蚭定䟋 説明
version v1.4.0 The version of julia
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

[julia]
symbol = '∎ '

Kotlin

The kotlin module shows the currently installed version of 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 '🅺 ' A format string representing the symbol of Kotlin.
style 'bold blue' モゞュヌルのスタむルです。
kotlin_binary 'kotlin' Configures the kotlin binary that Starship executes when getting the version.
disabled false Disables the kotlin module.

倉数

倉数 蚭定䟋 説明
version v1.4.21 The version of 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. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.

::: tip

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

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.

:::

オプション

オプション デフォルト 説明
symbol '☞ ' A format string representing the symbol displayed before the Cluster.
format '[$symbol$context( \($namespace\))]($style) in ' module のフォヌマットです。
style 'cyan bold' モゞュヌルのスタむルです。
context_aliases {} Table of context aliases to display.
user_aliases {} Table of user aliases to display.
detect_extensions [] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files [] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders [] どのフォルダヌがこのモゞュヌルをアクティブにするか
disabled true Disables the kubernetes module.

倉数

倉数 蚭定䟋 説明
context starship-context The current kubernetes context name
namespace starship-namespace If set, the current 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
[kubernetes.context_aliases]
'dev.local.cluster.k8s' = 'dev'
'.*/openshift-cluster/.*' = 'openshift'
'gke_.*_(?P<var_cluster>[\\w-]+)' = 'gke-$var_cluster'
[kubernetes.user_aliases]
'dev.local.cluster.k8s' = 'dev'
'root/.*' = 'root'

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

# ~/.config/starship.toml

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

Regex Matching

Additional to simple aliasing, context_aliases and user_aliases also supports extended matching and renaming using regular expressions.

The regular expression must match on the entire kube context, capture groups can be referenced using $name and $N in the replacement. This is more explained in the regex crate documentation.

Long and automatically generated cluster names can be identified and shortened using regular expressions:

[kubernetes.context_aliases]
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
'.*/openshift-cluster/.*' = 'openshift'
# Or better, to rename every OpenShift cluster at once:
'.*/(?P<var_cluster>[\\w-]+)/.*' = '$var_cluster'

# 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`):
'gke_.*_(?P<var_cluster>[\\w-]+)' = 'gke-$var_cluster'

Line Break

The line_break module separates the prompt into two lines.

オプション

オプション デフォルト 説明
disabled false Disables the line_break module, making the prompt a single line.

蚭定䟋

# ~/.config/starship.toml

[line_break]
disabled = true

Local IP

The localip module shows the IPv4 address of the primary network interface.

オプション

オプション デフォルト 説明
ssh_only true Only show IP address when connected to an SSH session.
format '[$localipv4]($style) ' module のフォヌマットです。
style 'bold yellow' モゞュヌルのスタむルです。
disabled true Disables the localip module.

倉数

倉数 蚭定䟋 説明
localipv4 192.168.1.13 Contains the primary IPv4 address
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

Lua

The lua module shows the currently installed version of Lua. デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに.lua-versionファむルが含たれおいる
  • カレントディレクトリにluaディレクトリが含たれおいる
  • カレントディレクトリに.luaの拡匵子のファむルが含たれおいる

オプション

オプション デフォルト 説明
format 'via [$symbol($version )]($style)' module のフォヌマットです。
version_format 'v${raw}' バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
symbol '🌙 ' A format string representing the symbol of Lua.
detect_extensions ['lua'] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files ['.lua-version'] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders ['lua'] どのフォルダヌがこのモゞュヌルをアクティブにするか
style 'bold blue' モゞュヌルのスタむルです。
lua_binary 'lua' Configures the lua binary that Starship executes when getting the version.
disabled false Disables the lua module.

倉数

倉数 蚭定䟋 説明
version v5.4.0 The version of lua
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

Memory Usage

The memory_usage module shows current system memory and swap usage.

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

::: tip

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

:::

オプション

オプション デフォルト 説明
threshold 75 Hide the memory usage unless it exceeds this percentage.
format 'via $symbol [${ram}( | ${swap})]($style) ' module のフォヌマットです。
symbol '🐏' The symbol used before displaying the memory usage.
style 'bold dimmed white' モゞュヌルのスタむルです。
disabled true Disables the memory_usage module.

倉数

倉数 蚭定䟋 説明
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 '
' The symbol used to indicate a branch name was truncated.
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

The nim module shows the currently installed version of 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

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

オプション

オプション デフォルト 説明
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 Disables the nix_shell module.
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

The nodejs module shows the currently installed version of 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 Disables the nodejs module.
not_capable_style bold red The style for the module when an engines property in package.json does not match the Node.js version.

倉数

倉数 蚭定䟋 説明
version v13.12.0 The version of node
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

OCaml

The ocaml module shows the currently installed version of 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

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

:::

オプション

オプション デフォルト 説明
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]
Alpine = "🏔 "
Amazon = "🙂 "
Android = "🀖 "
Arch = "🎗 "
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🊅 "
Gentoo = "🗜 "
HardenedBSD = "🛡 "
Illumos = "🐊 "
Linux = "🐧 "
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄ "
OpenBSD = "🐡 "
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 Version

The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm, 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 '📊 ' The symbol used before displaying the version the package.
version_format 'v${raw}' バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
style 'bold 208' モゞュヌルのスタむルです。
display_private false Enable displaying version for packages marked as private.
disabled false Disables the package module.

倉数

倉数 蚭定䟋 説明
version v1.0.0 The version of your package
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

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

Perl

The perl module shows the currently installed version of 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

The php module shows the currently installed version of PHP. デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリにcomposer.jsonファむルが含たれおいる
  • カレントディレクトリに.php-versionファむルが含たれおいる
  • カレントディレクトリに拡匵子が.phpのファむルが含たれおいる

オプション

オプション デフォルト 説明
format 'via [$symbol($version )]($style)' module のフォヌマットです。
version_format 'v${raw}' バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
symbol '🐘 ' The symbol used before displaying the version of PHP.
detect_extensions ['php'] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files ['composer.json', '.php-version'] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders [] どのフォルダヌがこのモゞュヌルをアクティブにするか
style '147 bold' モゞュヌルのスタむルです。
disabled false Disables the php module.

倉数

倉数 蚭定䟋 説明
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 '
' The symbol used to indicate a branch name was truncated.
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). If you still want to enable it, follow the example shown below.

:::

デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに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

The purescript module shows the currently installed version of PureScript version. デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに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.

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

デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに.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 Use pyenv to get Python version
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 Disables the python module.

::: tip

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

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

:::

倉数

倉数 蚭定䟋 説明
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

The rlang module shows the currently installed version of R. The module will be shown if any of the following conditions are met:

  • カレントディレクトリに拡匵子が.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

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

  • カレントディレクトリに拡匵子が.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

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

  • カレントディレクトリにGemfileファむルが含たれおいる
  • カレントディレクトリに .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 '💎 ' A format string representing the symbol of 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 Disables the ruby module.

倉数

倉数 蚭定䟋 説明
version v2.5.1 The version of ruby
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

# ~/.config/starship.toml

[ruby]
symbol = '🔺 '

Rust

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

  • カレントディレクトリにCargo.tomlファむルが含たれおいる
  • カレントディレクトリに.rsの拡匵子のファむルが含たれおいる

オプション

オプション デフォルト 説明
format 'via [$symbol($version )]($style)' module のフォヌマットです。
version_format 'v${raw}' バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
symbol '🊀 ' A format string representing the symbol of Rust
detect_extensions ['rs'] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files ['Cargo.toml'] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders [] どのフォルダヌがこのモゞュヌルをアクティブにするか
style 'bold red' モゞュヌルのスタむルです。
disabled false Disables the rust module.

倉数

倉数 蚭定䟋 説明
version v1.43.0-nightly The version of 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

The scala module shows the currently installed version of 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

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

:::

オプション

オプション デフォルト 説明
bash_indicator 'bsh' A format string used to represent bash.
fish_indicator 'fsh' A format string used to represent fish.
zsh_indicator 'zsh' A format string used to represent zsh.
powershell_indicator 'psh' A format string used to represent powershell.
ion_indicator 'ion' A format string used to represent ion.
elvish_indicator 'esh' A format string used to represent elvish.
tcsh_indicator 'tsh' A format string used to represent tcsh.
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* Mirrors the value of option 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.
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

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

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

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

:::

オプション

オプション デフォルト 説明
format '[$symbol$status]($style) ' The format of the module
symbol '❌' 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's 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

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

:::

オプション

オプション デフォルト 説明
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

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

  • カレントディレクトリに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

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

::: tip

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

:::

デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに.terraformフォルダが含たれおいる
  • 珟圚のディレクトリに .tf, .tfplan たたは .tfstate のいずれかの拡匵子を持぀ファむルがある。

オプション

オプション デフォルト 説明
format 'via [$symbol$workspace]($style) ' モゞュヌルのフォヌマット文字列。
version_format 'v${raw}' バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
symbol '💠' A format string shown before the terraform workspace.
detect_extensions ['tf', 'tfplan', 'tfstate'] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files [] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders ['.terraform'] どのフォルダヌがこのモゞュヌルをアクティブにするか
style 'bold 105' モゞュヌルのスタむルです。
disabled false Disables the terraform module.

倉数

倉数 蚭定䟋 説明
version v0.12.24 The version of terraform
workspace default The current Terraform workspace
symbol オプション symbol の倀をミラヌする
style* オプション style の倀をミラヌする

*: この倉数は、スタむル文字列の䞀郚ずしおのみ䜿甚するこずができたす。

蚭定䟋

Terraform バヌゞョン衚瀺あり

# ~/.config/starship.toml

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

Terraform バヌゞョン衚瀺なし

# ~/.config/starship.toml

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

時刻

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

::: tip

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

:::

オプション

オプション デフォルト 説明
format 'at [$time]($style) ' モゞュヌルのフォヌマット文字列。
use_12hr false Enables 12 hour formatting
time_format see below The chrono format string used to format the time.
style 'bold yellow' The style for the module time
utc_time_offset 'local' Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
disabled true Disables the time module.
time_range '-' Sets the time range during which the module will be shown. Times must be specified in 24-hours format

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

倉数

倉数 蚭定䟋 説明
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'

Username

The username module shows active user's username. The module will be shown if any of the following conditions are met:

  • The current user is root/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' The style used for non-root users.
format '[$user]($style) in ' module のフォヌマットです。
show_always false Always shows the username module.
disabled false Disables the username module.

倉数

倉数 蚭定䟋 説明
style 'red bold' Mirrors the value of option style_root when root is logged in and style_user otherwise.
user 'matchai' The currently logged-in user ID.

蚭定䟋

# ~/.config/starship.toml

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

Vagrant

The vagrant module shows the currently installed version of Vagrant. デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに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

The vlang module shows you your currently installed version of 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 the zig module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:

  • カレントディレクトリに拡匵子が.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.
shell See below
description '<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