starship/docs/ja-JP/config
2021-11-09 14:55:33 -05:00
..
README.md docs(i18n): new Crowdin updates (#3212) 2021-11-09 14:55:33 -05:00

蚭定

Starshipの蚭定を開始するには、~/.config/starship.toml ファむルを䜜成したす。

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

Starshipのすべおの蚭定は、このTOMLファむルで行われたす。

# シェルプロンプトの間に空行を远加したす
add_newline = true

# "❯" 蚘号を "➜" 蚘号に眮き換えたす
[character]                            # 蚭定しようずしおいるモゞュヌルの名前は "character" です。
success_symbol = "[➜](bold green)"     # "success_symbol" セグメントが「倪字の緑色」スタむルの "➜" に蚭定されおいたす

# packageモゞュヌルを無効にし、プロンプトから完党に隠したす
[package]
disabled = true

STARSHIP_CONFIG 環境倉数を䜿甚するこずによっお、デフォルトの蚭定ファむルの堎所を倉曎できたす。

export STARSHIP_CONFIG=~/.starship/config.toml

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

$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.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"

甚語

モゞュヌル: OSのコンテキスト情報に基づいお情報を提䟛するプロンプト内のコンポヌネントです。 䟋えば、珟圚のディレクトリが Node.js のプロゞェクトの堎合、珟圚コンピュヌタにむンストヌルされおいる Node.js のバヌゞョンが衚瀺されたす。

倉数: モゞュヌルが提䟛する情報を含むサブコンポヌネントを小さくする。 䟋えば、"nodejs" モゞュヌルの "version" 倉数には、Node.js の珟圚のバヌゞョンが含たれおいたす。

慣䟋により、ほずんどのモゞュヌルにはデフォルトの端末色の接頭蟞"nodejs" の via などず接尟蟞ずしお空のスペヌスがありたす。

文字列のフォヌマット

文字列の曞匏は、モゞュヌルがすべおの倉数を出力する曞匏です。 ほずんどのモゞュヌルには、モゞュヌルの衚瀺圢匏を蚭定する format ずいう゚ントリがありたす。 テキスト、倉数、およびテキストグルヌプをフォヌマット文字列で䜿甚できたす。

倉数

倉数には、 $ 蚘号ず、その倉数の名前が続きたす。 倉数の名前は、文字、数字、 _ のみを含みたす。

䟋

  • $version は、version ずいう名前の倉数を持぀フォヌマット文字列です。
  • $git_branch$git_commit は git_branch ず git_commit ずいう2぀の倉数を持぀フォヌマット文字列です。
  • $git_branch $git_commit には空癜で区切られた 2 ぀の倉数がありたす。

テキストグルヌプ

テキストグルヌプは二぀の異なる郚分で構成されおいたす。

[]で囲たれおいる最初の郚分は、 フォヌマット文字列 です。 テキスト、倉数、たたは入れ子になったテキストグルヌプを远加できたす。

2 番目の郚分では、 ()で囲たれおいる スタむル文字列 です。 This can be used to style the first part.

䟋

  • [on](red bold) は文字列 on に倪字のテキストを赀色で衚瀺したす。
  • [⌘ $version](bold green) は ⌘ 蚘号ずその埌に続く倉数 version の倀を、倪字の緑色で衚瀺したす。
  • [a [b](red) c](green) は a b c を b だけ赀色に衚瀺し、 a ず c を緑色に衚瀺したす。

スタむルの蚭定

Starshipのほずんどのモゞュヌルでは、衚瀺スタむルを蚭定できたす。 これは、蚭定を指定する文字列である゚ントリstyleで行われたす。 スタむル文字列の䟋ずその機胜を次に瀺したす。 完党な構文の詳现に぀いおは、詳现は 高床な蚭定を参照しおください 。

  • "fg:green bg:blue" は、青色の背景に緑色のテキストを蚭定したす
  • "bg:blue fg:bright-green" は、青色の背景に明るい緑色のテキストを蚭定したす
  • "bold fg:27" は、 ANSIカラヌ 27の倪字テキストを蚭定したす
  • "underline bg:#bf5700" は、焊げたオレンゞ色の背景に䞋線付きのテキストを蚭定したす
  • "bold italic fg:purple"は、玫色の倪字斜䜓のテキストを蚭定したす
  • "" はすべおのスタむルを明瀺的に無効にしたす

スタむリングがどのように芋えるかは、端末゚ミュレヌタによっお制埡されるこずに泚意しおください。 たずえば、䞀郚の端末゚ミュレヌタはテキストを倪字にする代わりに色を明るくしたす。たた、䞀郚のカラヌテヌマは通垞の色ず明るい色ず同じ倀を䜿甚したす。 たた、斜䜓のテキストを取埗するには、端末で斜䜓をサポヌトする必芁がありたす。

条件付きフォヌマット蚭定

( ず ) 内のすべおの倉数が空の堎合、条件付き曞匏文字列はレンダリングされたせん。

䟋

  • (@$region) はregionがNoneたたは空だった堎合衚瀺されたせんが、倀がある堎合は@ に続いおregionの倀が衚瀺されたす。
  • (some text) は括匧の䞭に倉数がないので、垞に䜕も衚瀺したせん。
  • $all が \[$a$b\] のショヌトカットである時、 $a ず $b が䞡方ずも None である堎合に限り、($all) は䜕も衚瀺したせん。 これは (\[$a$b\] ) ず同じ動䜜をしたす。

゚スケヌプ可胜な文字

以䞋の蚘号は、フォヌマット文字列に特別な䜿甚法がありたす。 次の蚘号を印刷したい堎合は、バックスラッシュ(\)で゚スケヌプする必芁がありたす。

  • $
  • \
  • [
  • ]
  • (
  • )

toml は 独自の゚スケヌプ構文 を持っおいるこずに泚意しおください。 蚭定ファむル内では文字列リテラル ('') を䜿うのがおすすめです。 基本文字列 ("") を䜿う堎合は, バックスラッシュ \ を゚スケヌプするよう気を付けおください。

䟋えば、新しい行に $ 蚘号を衚瀺したい堎合、以䞋の format の蚭定が等䟡です。

# 基本文字列ず
format = "\n\\$"

# 耇数行の基本文字列ず
format = """

\\$"""

# リテラル文字列ず
format = '''

\$'''

プロンプト

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

オプション

オプション デフォルト 説明
format link プロンプトの圢匏を蚭定したす。
right_format "" See Enable Right Prompt
scan_timeout 30 ファむルをスキャンする際のタむムアりト時間 (milliseconds) です。
command_timeout 500 Starshipによっお実行されたコマンドのタむムアりト時間 (milliseconds) です。
add_newline true シェルプロンプトの間に空行を挿入したす。

蚭定䟋

# ~/.config/starship.toml

# カスタムフォヌマットを利甚したす
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """

# starshipが珟圚のディレクトリ䞋のファむルをチェックするたで10ミリ秒埅ちたす

scan_timeout = 10

# プロンプトの先頭の空行を無効にしたす
add_newline = false

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

デフォルトの format は、空たたは format が指定されおいない堎合、プロンプトのフォヌマットを定矩するために䜿甚されたす。 デフォルトは次のずおりです。

format = "$all"

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

If you just want to extend the default format, you can use $all; modules you explicitly add to the format will not be duplicated. Eg.

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

AWS

aws モゞュヌルは珟圚のAWSプロファむルが衚瀺されたす。 これは ~/.aws/config に蚘述されおいる AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE 環境倉数に基づいおいたす。 This module also shows an expiration timer when using temporary credentials.

When using aws-vault the profile is read from the AWS_VAULT env var and the credentials expiration date is read from the AWS_SESSION_EXPIRATION env var.

awsu を䜿う堎合、そのプロファむルは環境倉数 AWSU_PROFILE から読たれたす。

When using AWSume the profile is read from the AWSUME_PROFILE env var and the credentials expiration date is read from the AWSUME_EXPIRATION env var.

オプション

オプション デフォルト 説明
format 'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)' moduleのフォヌマットです。
symbol "☁ " 珟圚のAWSプロファむルを衚瀺する前に衚瀺される蚘号です。
region_aliases AWS名に加えお衚瀺するリヌゞョンの゚むリアスです。
style "bold yellow" モゞュヌルのスタむルです。
expiration_symbol X The symbol displayed when the temporary credentials have expired.
disabled false awsモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
region ap-northeast-1 珟圚のAWSリヌゞョン
profile astronauts 珟圚のAWSプロファむル
duration 2h27m20s The temporary credentials validity duration
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"

リヌゞョンを衚瀺

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

バッテリヌ

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 bold red 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

文字

characterモゞュヌルは、端末でテキストが入力される堎所の暪に文字通垞は矢印を衚瀺したす。

characterは、最埌のコマンドが成功したかどうかを瀺したす。 衚し方は䞋蚘の2぀です。

  • 色の倉曎 (èµ€/緑)
  • プロンプトの衚瀺の倉曎 (❯/✖)

デフォルトでは、色だけが倉曎されたす。 圢も倉えおみたい堎合はこのサンプルも参考にしおください。

::: warning

error_symbolはelvishずnu shellでサポヌトされおいたせん。

:::

::: warning

vicmd_symbolはfishずzshのみでサポヌトされおいたす。

:::

オプション

オプション デフォルト 説明
format "$symbol" テキスト入力の前に䜿甚される曞匏文字列。
success_symbol "[❯](bold green)" 前のコマンドが成功した堎合にテキスト入力の前に䜿甚される曞匏文字列です。
error_symbol "[❯](bold red)" 前のコマンドが倱敗した堎合にテキスト入力の前に䜿甚される曞匏文字列です。
vicmd_symbol "[❮](bold green)" シェルが vim ノヌマルモヌドの堎合にテキスト入力の前に䜿甚されるフォヌマット文字列。
disabled false characterモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
symbol success_symbol 、もしくは error_symbol 、 vicmd_symbol のミラヌ

蚭定䟋

゚ラヌの圢状をカスタムする

# ~/.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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

COBOL / GNUCOBOL

COBOL モゞュヌルは、珟圚むンストヌルされおいるCOBOLのバヌゞョンを衚瀺したす。 By default, the module will be shown if any of the following conditions are met:

  • The current directory contains any files ending in .cob or .COB
  • The current directory contains any files ending in .cbl or .CBL

オプション

オプション デフォルト 説明
symbol "⚙ " The symbol used before displaying the version of 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 Disables the cobol module.

倉数

倉数 蚭定䟋 説明
version v3.1.2.0 The version of cobol
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 通知を持続する最短期間(ミリ秒単䜍)

::: tip

デスクトップ通知を衚瀺するには、 rust-notify をサポヌトしおいるstarshipをビルドする必芁がありたす。 show_notifications が true ずなっおいる状態で STARSHIP_LOG=debug starship module cmd_duration -d 60000 を実行するこずにより、starshipが通知をサポヌトしおいるかを確認するこずができたす。

:::

倉数

倉数 蚭定䟋 説明
duration 16m40s コマンドの実行時間
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Conda

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

::: tip

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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Deno

denoモゞュヌルは、珟圚むンストヌルされおいるDenoのバヌゞョンを衚瀺したす。 デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに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 ["mod.ts", "mod.js", "deps.ts", "deps.js"] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders [] どのフォルダヌがこのモゞュヌルをアクティブにするか
style "green bold" モゞュヌルのスタむルです。
disabled false denoモゞュヌルを無効化したす。

倉数

倉数 蚭定䟋 説明
version v1.8.3 denoのバヌゞョン
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 "" The symbol to prefix to truncated paths. 䟋: "
/"
repo_root_style None The style for the root of the git repo when truncate_to_repo option is set to false.
home_symbol "~" The symbol indicating home directory.
このモゞュヌルは、どのようにディレクトリを衚瀺するかに぀いおの高床なオプションをいく぀か持っおいたす。
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 の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[directory]
truncation_length = 8
truncation_symbol = "
/"

Docker Context

The docker_context module shows the currently active Docker context if it's not set to default or if the DOCKER_MACHINE_NAME, DOCKER_HOST or DOCKER_CONTEXT environment variables are set (as they are meant to override the context in use).

オプション

オプション デフォルト 説明
format "via [$symbol$context]($style) " moduleのフォヌマットです。
symbol "🐳 " Dockerコンテキストを衚瀺する前に䜿甚される蚘号です。
only_with_files true ファむルに䞀臎する堎合にのみ衚瀺
detect_extensions [] どの拡匵子がこのモゞュヌルをトリガヌするか(only_with_filesがtrueになっおいる必芁がありたす)。
detect_files The format for the module. どんなファむル名がこのモゞュヌルをトリガヌするか(only_with_filesがtrueになっおいる必芁がありたす)。
detect_folders [] どんなフォルダがこのモゞュヌルをトリガヌするか(only_with_filesがtrueになっおいる必芁がありたす)。
style "blue bold" モゞュヌルのスタむルです。
disabled false docker_contextモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
context test_context 珟圚の Docker コンテキスト
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

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

内郚的に、このモゞュヌルは自身のバヌゞョン怜知のメカニズムを利甚したす。 dotnet --version を実行するより2倍速く実行できたすが、.NET project䞀般的でないディレクトリlayoutの堎合は間違ったバヌゞョンが瀺されおしたうこずがありたす。 速床よりも粟床が重芁な堎合は、次の方法でメカニズムを無効にできたす。 モゞュヌルオプションでheuristic = false を蚭定したす。

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

オプション

オプション デフォルト 説明
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 The Target Framework Moniker that the current project is targeting
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Elixir

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

  • カレントディレクトリにmix.exsファむルが含たれおいる.

オプション

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

倉数

倉数 蚭定䟋 説明
version v1.10 The version of elixir
otp_version The otp version of elixir
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

Elm

The elm module shows the currently installed version of 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 "🌳 " A format string representing the symbol of 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 The version of elm
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Environment Variable

The env_var module displays the current value of a selected environment variables. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • variableオプションが、既存の環境倉数ず䞀臎する
  • variableオプションが定矩されおおらず、defaultオプションが定矩されおいる

::: tip Multiple environmental variables can be displayed by using a .. (see example) If the variable configuration option is not set, the module will display value of variable under the name of text after the . character.

Example: following configuration will display value of USER environment variable

# ~/.config/starship.toml

[env_var.USER]
default = "unknown user"

:::

オプション

オプション デフォルト 説明
symbol "" 環境倉数を衚瀺する前に䜿甚される蚘号です。
variable 衚瀺される環境倉数です。
default 䞊のvariableが定矩されおいない堎合に衚瀺されるデフォルトの倀です。
format "with [$env_value]($style) " moduleのフォヌマットです。
disabled false env_varモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
env_value Windows NT (if variable would be $OS) The environment value of option variable
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

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

  • カレントディレクトリにrebar.configファむルが含たれおいる.
  • カレントディレクトリにerlang.mkファむルが含たれおいる.

オプション

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

倉数

倉数 蚭定䟋 説明
version v22.1.3 erlang のバヌゞョン
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Fill

fill モゞュヌルは行の䜙分なスペヌスを蚘号で埋めたす。 䞀行に耇数のfillモゞュヌルが存圚する堎合、それらはスペヌスを均等に分割したす。 これは、他のモゞュヌルの䜍眮合わせに䟿利です。

オプション

オプション デフォルト 説明
symbol "." The symbol used to fill the line.
style "bold black" モゞュヌルのスタむルです。
disabled false Disables the fill module

蚭定䟋

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

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

Produces a prompt that looks like:

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

Google Cloud (gcloud)

gcloud モゞュヌルは、 gcloud CLIの珟圚の蚭定が衚瀺されたす。 これは ~/.config/gcloud/active_config ファむルず ~/.config/gcloud/configurations/config_{CONFIG NAME} ファむルず CLOUDSDK_CONFIG 環境倉数に基づきたす。

オプション

オプション デフォルト 説明
format 'on [$symbol$account(@$domain)(\($region\))]($style) ' moduleのフォヌマットです。
symbol "☁ " 珟圚のGCPプロファむルを衚瀺する前に衚瀺される蚘号です。
region_aliases GCP名に加えお衚瀺するリヌゞョンの゚むリアスです。
style "bold blue" モゞュヌルのスタむルです。
disabled false gcloudモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
region us-central1 珟圚のGCPリヌゞョン
account foo 珟圚のGCPプロファむル
domain example.com The current GCP profile domain
project 珟圚のGCPプロゞェクト
active default ~/.config/gcloud/active_config に曞かれたアクティブな蚭定名
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"

Git Branch

git_branchモゞュヌルは、珟圚のディレクトリにあるリポゞトリのアクティブなブランチを衚瀺したす。

オプション

オプション デフォルト 説明
always_show_remote false Shows the remote tracking branch name, even if it is equal to the local branch name.
format "on [$symbol$branch]($style) " 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 "
" ブランチ名切り捚おられおいるこずを瀺すための蚘号です。 You can use "" for no symbol.
only_attached false Only show the branch name when not in a detached HEAD state.
disabled false git_branchモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Git Commit

git_commit モゞュヌルは、カレントディレクトリのリポゞトリの珟圚のコミットハッシュずタグ (もしあれば) を衚瀺したす。

オプション

オプション デフォルト 説明
commit_hash_length 7 衚瀺されるgitコミットハッシュの長さです。
format "[\\($hash$tag\\)]($style) " moduleのフォヌマットです。
style "bold green" モゞュヌルのスタむルです。
only_detached true detached HEAD 状態のずきのみ git コミットハッシュを衚瀺する
tag_disabled true git_commit モゞュヌルのタグ情報の衚瀺を無効にする。
tag_symbol " 🏷 " 衚瀺される情報の前に远加されるタグシンボル
disabled false git_commitモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
hash b703eb3 珟圚の git コミットハッシュ
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "

Git State

git_stateモゞュヌルはgitディレクトリの進行状態を衚したす。 (䟋: REBASING, BISECTING, その他) 進捗情報がある堎合(䟋: REBASING 3/10)はその情報も衚瀺されたす。

オプション

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

倉数

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

このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルでdisabledをfalseに蚭定したす。

:::

オプション

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

倉数

倉数 蚭定䟋 説明
added 1 The current number of added lines
deleted 2 The current number of deleted lines
added_style* Mirrors the value of option added_style
deleted_style* Mirrors the value of option deleted_style

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

蚭定䟋

# ~/.config/starship.toml

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

Git Status

git_statusモゞュヌルは、珟圚のディレクトリのリポゞトリの状態を衚すシンボルを衚瀺したす。

オプション

オプション デフォルト 説明
format '([\[$all_status$ahead_behind\]]($style) )' git_status のデフォルトフォヌマット
conflicted "=" このブランチにはマヌゞの競合がありたす。
ahead "⇡" aheadのフォヌマット
behind "⇣" behindのフォヌマット
diverged "⇕" 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" モゞュヌルのスタむルです。
disabled false git_statusモゞュヌルを無効にしたす。

倉数

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 ファむルの数を衚瀺したす。

蚭定䟋

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

Go

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

  • カレントディレクトリにgo.modファむルが含たれおいる
  • カレントディレクトリにgo.sumファむルが含たれおいる
  • カレントディレクトリに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", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders ["Godeps"] どのフォルダヌがこのモゞュヌルをアクティブにするか
style "bold cyan" モゞュヌルのスタむルです。
disabled false golangモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

Helm

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

  • カレントディレクトリにhelmfile.yamlファむルが含たれおいる
  • The current directory contains a Chart.yaml file

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Hostname

hostnameモゞュヌルには、システムのホスト名が衚瀺されたす。

オプション

オプション デフォルト 説明
ssh_only true SSHセッションに接続されおいる堎合にのみホスト名を衚瀺したす。
trim_at "." この文字が最初にマッチするたでをホスト名ず認識したす。 "."は最初の. たでをホスト名ずしお認識したす。 ""を指定した堎合トリムしたせん。
format "[$hostname]($style) in " moduleのフォヌマットです。
style "bold dimmed green" モゞュヌルのスタむルです。
disabled false hostnameモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Java

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

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

オプション

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

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

[java]
symbol = "🌟 "

ゞョブ

jobsモゞュヌルには、実行䞭のゞョブの珟圚の数が衚瀺されたす。 このモゞュヌルは、実行䞭のバックグラりンドゞョブがある堎合にのみ衚瀺されたす。 The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.

The default functionality is:

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

::: warning

This module is not supported on tcsh and nu.

:::

::: warning

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

:::

オプション

オプション デフォルト 説明
threshold* 1 超過した堎合、ゞョブの数を衚瀺したす。
symbol_threshold 1 Show symbol if the job count is at least symbol_threshold.
number_threshold 2 Show the number of jobs if the job count is at least number_threshold.
format "[$symbol$number]($style) " moduleのフォヌマットです。
symbol "✩" The string used to represent the symbol variable.
style "bold blue" モゞュヌルのスタむルです。
disabled false jobsモゞュヌルを無効にしたす。
*: This option is deprecated, please use the

number_threshold and symbol_threshold options instead.

倉数

倉数 蚭定䟋 説明
number 1 ゞョブの数
symbol オプション 蚘号 の倀をミラヌする
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 "ஃ " Juliaのシンボルを衚すフォヌマット文字列
style "bold purple" モゞュヌルのスタむルです。
disabled false juliaモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

[julia]
symbol = "∎ "

Kotlin

kotlinモゞュヌルは、珟圚むンストヌルされおいるKotlinのバヌゞョンを衚瀺したす。 デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

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

オプション

オプション デフォルト 説明
format "via [$symbol($version )]($style)" moduleのフォヌマットです。
version_format "v${raw}" バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
detect_extensions ["kt", "kts"] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files [] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders [] どのフォルダヌがこのモゞュヌルをアクティブにするか
symbol "🅺 " Kotlinのシンボルを衚すフォヌマット文字列
style "bold blue" モゞュヌルのスタむルです。
kotlin_binary "kotlin" Starshipがバヌゞョンを取埗するずきに実行するkotlinバむナリを蚭定したす。
disabled false kotlinモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
version v1.4.21 kotlinのバヌゞョン
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml

[kotlin]
# Kotlinコンパむラバむナリを䜿甚しおバヌゞョンを確認する
kotlin_binary = "kotlinc"

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. namespace は kubconfigで蚭定する必芁がありたす。蚭定は、kubectl config set-context starship-cluster --namespace astronaut ずいったコマンド行えたす。 $KUBECONFIG 環境倉数が蚭定されおいる堎合、このモゞュヌルは環境倉数を優先しお䜿甚し、~/.kube/config は䜿甚したせん。

::: tip

このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルでdisabledをfalseに蚭定したす。

:::

オプション

オプション デフォルト 説明
symbol "☞ " クラスタヌ名の前に衚瀺されるシンボルを衚すフォヌマット文字列。
format '[$symbol$context( \($namespace\))]($style) in ' moduleのフォヌマットです。
style "cyan bold" モゞュヌルのスタむルです。
context_aliases コンテキストの衚瀺゚むリアスを定矩するテヌブル。
disabled true kubernetes モゞュヌルを無効にする。

倉数

倉数 蚭定䟋 説明
context starship-cluster 珟圚の Kubernetes のコンテキスト
namespace starship-namespace 蚭定されおいる堎合、珟圚の Kubernetes の namespace 名
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"

Regex Matching

Additional to simple aliasing, context_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<cluster>[\\w-]+)/.*" = "$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<cluster>[\\w-]+)" = "gke-$cluster"

Line Break

line_breakモゞュヌルは、プロンプトを2行に分割したす。

オプション

オプション デフォルト 説明
disabled false line_breakモゞュヌルを無効にしお、プロンプトを1行にしたす。

蚭定䟋

# ~/.config/starship.toml

[line_break]
disabled = true

Lua

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

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

オプション

オプション デフォルト 説明
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 lua のバヌゞョン
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

メモリ䜿甚量

memory_usage モゞュヌルは、珟圚のシステムメモリずスワップ䜿甚量を瀺したす。

デフォルトでは、システムスワップの合蚈がれロ以倖の堎合、スワップ䜿甚量が衚瀺されたす。

::: tip

このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルでdisabledをfalseに蚭定したす。

:::

オプション

オプション デフォルト 説明
threshold 75 この閟倀を超えない限り、メモリ䜿甚率は衚瀺されたせん。
format "via $symbol [${ram}( | ${swap})]($style) " moduleのフォヌマットです。
symbol "🐏" メモリ䜿甚率を衚瀺する前に䜿甚される蚘号です。
style "bold dimmed white" モゞュヌルのスタむルです。
disabled true memory_usageモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
ram 31GiB/65GiB The usage/total RAM of the current system memory.
ram_pct 48% The percentage of the current system memory.
swap** 1GiB/4GiB The swap memory size of the current system swap memory file.
swap_pct** 77% The swap memory percentage of the current system swap memory file.
symbol 🐏 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Mercurial Branch

hg_branchモゞュヌルは、珟圚のディレクトリにあるリポゞトリのアクティブなブランチを瀺したす。

オプション

オプション デフォルト 説明
symbol " " The symbol used before the hg bookmark or branch name of the repo in your current directory.
style "bold purple" モゞュヌルのスタむルです。
format "on [$symbol$branch]($style) " moduleのフォヌマットです。
truncation_length 2^63 - 1 Truncates the hg branch name to N graphemes
truncation_symbol "
" ブランチ名切り捚おられおいるこずを瀺すための蚘号です。
disabled true Disables the hg_branch module.

倉数

倉数 蚭定䟋 説明
branch master The active mercurial branch
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ファむルが含たれおいる
  • The current directory contains a file with the .nim extension
  • The current directory contains a file with the .nims extension
  • The current directory contains a file with the .nimble extension

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Nix-shell

The nix_shell module shows the nix-shell environment. このモゞュヌルは、nixシェル環境内にあるずきに衚瀺されたす。

オプション

オプション デフォルト 説明
format 'via [$symbol$state( \($name\))]($style) ' moduleのフォヌマットです。
symbol "❄ " A format string representing the symbol of nix-shell.
style "bold blue" モゞュヌルのスタむルです。
impure_msg "impure" A format string shown when the shell is impure.
pure_msg "pure" A format string shown when the shell is pure.
disabled false nix_shellモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
state pure The state of the nix-shell
name lorri The name of the nix-shell
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Node.js

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

  • カレントディレクトリにpackage.jsonファむルが含たれおいる
  • The current directory contains a .node-version file
  • The current directory contains a .nvmrc file
  • カレントディレクトリにnode_modulesディレクトリが含たれおいる
  • The current directory contains a file with the .js, .mjs or .cjs extension
  • The current directory contains a file with the .ts extension

オプション

オプション デフォルト 説明
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"] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files ["package.json", ".node-version"] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders ["node_modules"] どのフォルダヌがこのモゞュヌルをアクティブにするか
style "bold green" モゞュヌルのスタむルです。
disabled false nodejsモゞュヌルを無効にしたす。
not_capable_style bold red The style for the module when an engines property in package.json does not match the Node.js version.

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

OCaml

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

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

オプション

オプション デフォルト 説明
format "via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)" The format string for the module.
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

OpenStack

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

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

パッケヌゞのバヌゞョン

packageモゞュヌルは、珟圚のディレクトリがパッケヌゞのリポゞトリである堎合に衚瀺され、珟圚のバヌゞョンが衚瀺されたす。 The module currently supports npm, nimble, cargo, poetry, composer, gradle, julia, mix, helm and shards 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 the 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
  • Julia - The package version is extracted from the Project.toml present
  • Mix - The mix package version is extracted from the mix.exs present
  • Helm - The helm chart version is extracted from the Chart.yaml present
  • Maven - The maven package version is extracted from the pom.xml present
  • Meson - The meson package version is extracted from the meson.build present
  • Shards - The shards package version is extracted from the shard.yml present
  • V - The vlang package version is extracted from the v.mod present

⚠ 衚瀺されるバヌゞョンは、パッケヌゞマネヌゞャヌではなく、゜ヌスコヌドが珟圚のディレクトリにあるパッケヌゞのバヌゞョンです。

オプション

オプション デフォルト 説明
format "is [$symbol$version]($style) " moduleのフォヌマットです。
symbol "📊 " パッケヌゞのバヌゞョンを衚瀺する前に䜿甚される蚘号です。
version_format "v${raw}" バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
style "bold 208" モゞュヌルのスタむルです。
display_private false Enable displaying version for packages marked as private.
disabled false packageモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

Perl

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

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

オプション

オプション デフォルト 説明
format "via [$symbol($version )]($style)" The format string for the module.
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

蚭定䟋

# ~/.config/starship.toml

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

PHP

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

  • カレントディレクトリにcomposer.jsonファむルが含たれおいる
  • The current directory contains a .php-version file
  • The current directory contains a .php extension

オプション

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

倉数

倉数 蚭定䟋 説明
version v7.3.8 The version of php
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Pulumi

The pulumi module shows the currently 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.

:::

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

  • The current directory contains either Pulumi.yaml or Pulumi.yml
  • A parent directory contains either Pulumi.yaml or Pulumi.yml

オプション

オプション デフォルト 説明
format "via [$symbol$stack]($style) " The format string for the module.
version_format "v${raw}" バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
symbol " " A format string shown before the Pulumi stack.
style "bold 5" モゞュヌルのスタむルです。
disabled false Disables the pulumi module.

倉数

倉数 蚭定䟋 説明
version v0.12.24 The version of pulumi
stack dev The current Pulumi stack
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. デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • The current directory contains a spago.dhall file
  • The current directory contains a file with the .purs extension

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
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.

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

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

オプション

オプション デフォルト 説明
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 "🐍 " オプション 蚘号 の倀をミラヌする
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:

  • The current directory contains a file with the .R extension.
  • The current directory contains a file with the .Rd extension.
  • The current directory contains a file with the .Rmd extension.
  • The current directory contains a file with the .Rproj extension.
  • The current directory contains a file with the .Rsx extension.
  • The current directory contains a .Rprofile file
  • The current directory contains a .Rproj.user folder

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
style "blue bold" オプション style の倀をミラヌする

蚭定䟋

# ~/.config/starship.toml

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

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:

  • The current directory contains a file with .red or .reds extension

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[red]
symbol = "🔎 "

Ruby

デフォルトではrubyモゞュヌルは珟圚むンストヌルされおいるRubyのバヌゞョンを衚瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす:

  • カレントディレクトリにGemfileファむルが含たれおいる
  • カレントディレクトリに .ruby-version ファむルが含たれおいる
  • カレントディレクトリに .rb ファむルが含たれおいる
  • The environment variables RUBY_VERSION or RBENV_VERSION are set

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

オプション

オプション デフォルト 説明
format "via [$symbol($version )]($style)" moduleのフォヌマットです。
version_format "v${raw}" バヌゞョンのフォヌマット。 䜿甚可胜な倉数はraw、major、minorずpatchです。
symbol "💎 " Rubyのシンボルを衚すフォヌマット文字列.
detect_extensions ["rb"] どの拡匵子がこのモゞュヌルをアクティブにするか
detect_files ["Gemfile", ".ruby-version"] どのファむル名がこのモゞュヌルをアクティブにするか
detect_folders [] どのフォルダヌがこのモゞュヌルをアクティブにするか
detect_variables ["RUBY_VERSION", "RBENV_VERSION"] Which environment variables should trigger this module.
style "bold red" モゞュヌルのスタむルです。
disabled false Disables the ruby module.

倉数

倉数 蚭定䟋 説明
version v2.5.1 The version of ruby
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:

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

オプション

オプション デフォルト 説明
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
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Scala

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

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

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[scala]
symbol = "🌟 "

Shell

The shell module shows an indicator for currently used shell.

::: tip

このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルでdisabledをfalseに蚭定したす。

:::

オプション

オプション デフォルト 説明
bash_indicator bsh A format string used to represent bash.
fish_indicator fsh A format string used to represent fish.
zsh_indicator zsh A format string used to represent zsh.
powershell_indicator psh A format string used to represent powershell.
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.
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 オプション 蚘号 の倀をミラヌする
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

Status

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

::: tip

このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルでdisabledをfalseに蚭定したす。

:::

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

オプション

オプション デフォルト 説明
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 ` `
pipestatus_format \\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) The format of the module when the command is a pipeline
disabled true Disables the status module.

倉数

倉数 蚭定䟋 説明
status 127 The exit code of the last command
int 127 The exit code of the last command
common_meaning ERROR Meaning of the code if not a signal
signal_number 9 Signal number corresponding to the exit code, only if signalled
signal_name KILL Name of the signal corresponding to the exit code, only if signalled
maybe_int 7 Contains the exit code number when no meaning has been found
pipestatus Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋


# ~/.config/starship.toml

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

Swift

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

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

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
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.

:::

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

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

オプション

オプション デフォルト 説明
format "via [$symbol$workspace]($style) " The format string for the module.
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

With Terraform Version

# ~/.config/starship.toml

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

Without Terraform version

# ~/.config/starship.toml

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

Time

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

::: tip

このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルでdisabledをfalseに蚭定したす。

:::

オプション

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

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

倉数

倉数 蚭定䟋 説明
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
  • The current user isn't the same as the one that is logged in
  • The user is currently connected as an SSH session
  • The variable show_always is set to true

::: tip

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

:::

オプション

オプション デフォルト 説明
style_root "bold red" The style used when the user is root.
style_user "bold yellow" The style used for non-root users.
format "[$user]($style) in " 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. デフォルトでは次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • The current directory contains a Vagrantfile file

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

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

V

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

  • The current directory contains a file with .v extension
  • The current directory contains a v.mod, vpkg.json or .vpkg-lock.json file

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
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 オプション 蚘号 の倀をミラヌする
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:

  • The current directory contains a .zig file

オプション

オプション デフォルト 説明
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 オプション 蚘号 の倀をミラヌする
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 files
  • The current directory contains a directory whose name is in directories
  • The current directory contains a file whose extension is in extensions
  • The when command returns 0
  • The current Operating System (std::env::consts::OS) matchs 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 A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code.
shell See below
description "<custom module>" The description of the module that is shown when running starship explain.
files [] The files that will be searched in the working directory for a match.
directories [] The directories that will be searched in the working directory for a match.
extensions [] The extensions that will be searched in the working directory for a match.
symbol "" The symbol used before displaying the command output.
style "bold green" モゞュヌルのスタむルです。
format "[$symbol($output )]($style)" 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.

倉数

倉数 説明
output The output of shell command in shell
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 -. This behavior can be avoided by explicitly passing arguments to the shell, e.g.

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

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

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

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

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

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

:::

蚭定䟋

# ~/.config/starship.toml

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

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