starship/docs/ja-JP/config
2020-11-28 23:45:59 -05:00
..
README.md docs(i18n): New Crowdin updates (#1788) 2020-11-28 23:45:59 -05:00

蚭定

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

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

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

# プロンプトの先頭に改行を衚瀺したせん
add_newline = false

# プロンプトの「❯」蚘号を「➜」に眮き換えたす
[character]                            # 蚭定しおいるモゞュヌルの名前は「character」です
success_symbol = "[➜](bold green)"     # 「success_symbol」セグメントは「ボヌルドグリヌン」の色で「➜」に蚭定されおいたす

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

STARSHIP_CONFIG 環境倉数を䜿甚しお、デフォルトのstarship.toml ファむルの堎所を倉曎できたす。

export STARSHIP_CONFIG=~/.starship

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

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

ロギング

デフォルトでは、Starship は譊告や゚ラヌログを ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log ずいう名前のファむルに出力したす。このセッションキヌはタヌミナルのむンスタンスに盞圓したす。しかし、これは STARSHIP_CACHE ずいう環境倉数を䜿っお倉曎できたす しかし、これは STARSHIP_CACHE ずいう環境倉数を䜿っお倉曎できたす

export STARSHIP_CACHE=~/.starship/cache

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

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

甚語

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

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

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

文字列のフォヌマット

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

倉数

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

䟋

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

テキストグルヌプ

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

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

2 番目の郚分では、 ()で囲たれおいる スタむル文字列 です。 これは最初のパヌトのスタむルを䜿甚するこずができたす。

䟋

  • [on](red bold) は文字列 on に倪字のテキストを赀色で衚瀺したす。
  • [⬢ $version](bold green) はシンボル ⬢ の埌に倉数 バヌゞョンの内容を衚瀺したす 緑色の倪字を付けおいたす
  • [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) will show nothing if the variable region is None, otherwise @ followed by the value of region.
  • (some text) will always show nothing since there are no variables wrapped in the braces.
  • When $all is a shortcut for \[$a$b\], ($all) will show nothing only if $a and $b are both None. This works the same as (\[$a$b\] ).

゚スケヌプ可胜な文字

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

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

toml は 独自の゚スケヌプ構文 を持っおいるこずに泚意しおください。 It is recommended to use a literal string ('') in your config. If you want to use a basic string (""), pay attention to escape the backslash \.

For example, when you want to print a $ symbol on a new line, the following configs for format are equivalent:

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

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

\\$"""

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

\$'''

プロンプト

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

オプション

オプション デフォルト 説明
format link プロンプトの圢匏を蚭定したす。
scan_timeout 30 ファむルをスキャンする際のタむムアりト時間 (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\
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$ruby\
$rust\
$swift\
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$cmd_duration\
$custom\
$line_break\
$lua\
$jobs\
$battery\
$time\
$status\
$character"""

AWS

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

aws-vaultを䜿甚する堎合、プロファむル はAWS_VAULTenv varから読み取られたす。

オプション

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

倉数

倉数 蚭定䟋 説明
region ap-northeast-1 珟圚のAWSリヌゞョン
profile astronauts 珟圚のAWSプロファむル
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 "⇣" バッテリヌが攟電しおいるずきに衚瀺される蚘号です。
format "[$symbol$percentage]($style) " moduleのフォヌマットです。
display link モゞュヌルの閟倀ずスタむルを衚瀺したす。
disabled false batteryモゞュヌルを無効にしたす。
いく぀かのたれなバッテリヌ状態のオプションもありたす。
倉数 説明
unknown_symbol バッテリヌ状態が䞍明なずきに衚瀺される蚘号です。
empty_symbol バッテリヌが空のずきに衚瀺される蚘号です。

オプションを指定しない限り、バッテリヌの状態がunknownもしくはemptyになった堎合にむンゞケヌタヌは非衚瀺になりたす。

蚭定䟋

# ~/.config/starship.toml

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

バッテリヌの衚瀺

display オプションを䜿甚しお、バッテリヌむンゞケヌタヌを衚瀺するタむミング閟倀ず倖芳スタむルを定矩したす。 display が提䟛されない堎合、 デフォルトは次のずおりです。

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

オプション

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

オプション 説明
threshold バッテリヌが衚瀺される䞊限です。
style displayオプションが䜿甚されおいる堎合のスタむルです。

蚭定䟋

[[battery.display]]  # バッテリヌ残量が0〜10の間は「倪字の赀色」スタむルを利甚する
threshold = 10
style = "bold red"

[[battery.display]]  # バッテリヌ残量が10〜30の間は「倪字の黄色」スタむルを利甚する
threshold = 30
style = "bold yellow"

# 容量が30を超えるず、バッテリヌむンゞケヌタヌは衚瀺されたせん

文字

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

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

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

デフォルトでは、色だけが倉曎されたす。 If you also want to change it's shape take a look at this example.

オプション

オプション デフォルト 説明
format "$symbol " The format string used before the text input.
success_symbol "[❯](bold green)" The format string used before the text input if the previous command succeeded.
error_symbol "[❯](bold red)" The format string used before the text input if the previous command failed.
vicmd_symbol "[❮](bold green)" The format string used before the text input if the shell is in vim normal mode.
disabled false characterモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
symbol A mirror of either success_symbol, error_symbol or vicmd_symbol

蚭定䟋

With custom error shape

# ~/.config/starship.toml

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

Without custom error shape

# ~/.config/starship.toml

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

With custom vim shape

# ~/.config/starship.toml

[character]
vicmd_symbol = "[V](bold green) "

CMake

The cmake module shows the currently installed version of CMake if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol " " The symbol used before the version of cmake.
style "bold blue" モゞュヌルのスタむルです。
disabled false Disables the cmake module.

倉数

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

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

コマンド実行時間

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 Show desktop notifications when command completes.
min_time_to_notify 45_000 Shortest duration for notification (in milliseconds).

::: tip

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

:::

倉数

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

This does not suppress conda's own prompt modifier, you may want to run conda config --set changeps1 False.

:::

オプション

オプション デフォルト 説明
truncation_length 1 環境がconda create -p [path]で䜜成された堎合、環境パスが切り捚おられるディレクトリ数。 0は切り捚おがないこずを意味したす。 directoryもご芧ください。
symbol "🅒 " 環境名の盎前に䜿甚されるシンボルです。
style "bold green" モゞュヌルのスタむルです。
format "[$symbol$environment]($style) " moduleのフォヌマットです。
ignore_base true Ignores base environment when activated.
disabled false condaモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

Crystal

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

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

オプション

オプション デフォルト 説明
symbol "🔮 " Crystalのバヌゞョンを衚瀺する前に䜿甚される蚘号です。
style "bold red" モゞュヌルのスタむルです。
format "via [$symbol$version]($style) " moduleのフォヌマットです。
disabled false crystalモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

Dart

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

  • The current directory contains a file with .dart extension
  • The current directory contains a .dart_tool directory
  • カレントディレクトリにpubspec.yaml, もしくはpubspec.lockファむルが含たれおいる

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "🎯 " A format string representing the symbol of Dart
style "bold blue" モゞュヌルのスタむルです。
disabled false Disables the dart module.

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

ディレクトリ

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

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

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

オプション

オプション デフォルト 説明
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 "🔒" The symbol indicating current directory is read only.
read_only_style "red" The style for the read only symbol.
truncation_symbol "" The symbol to prefix to truncated paths. eg: "
/"
This module has a few advanced configuration options that control how the directory is displayed.
Advanced Option デフォルト 説明
substitutions A table of substitutions to be made to the path.
fish_style_pwd_dir_length 0 fish shellのpwdパスロゞックを適甚するずきに䜿甚する文字数です。
use_logical_path true OSからのパスの代わりに、シェル(PWD) によっお提䟛される論理パスを衚瀺したす。

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" The current directory path
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.

オプション

オプション デフォルト 説明
format "via [$symbol$context]($style) " moduleのフォヌマットです。
symbol "🐳 " The symbol used before displaying the Docker context.
style "blue bold" モゞュヌルのスタむルです。
only_with_files false Only show when there's a docker-compose.yml or Dockerfile in the current directory.
disabled true docker_contextモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

Dotnet

The dotnet module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.

This module will only be shown in your prompt when one or more of the following files are present in the current directory:

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

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

Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false in the module options.

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

オプション

オプション デフォルト 説明
format "v[$symbol$version( 🎯 $tfm)]($style) " moduleのフォヌマットです。
symbol •NET " dotnetのバヌゞョンを衚瀺する前に䜿甚される蚘号です。
heuristic true より高速なバヌゞョン怜出を䜿甚しお、starshipの動䜜を維持したす。
style "bold blue" モゞュヌルのスタむルです。
disabled false dotnetモゞュヌルを無効にしたす。

倉数

倉数 蚭定䟋 説明
version v3.1.201 The version of 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. The module will be shown if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
symbol "💧 " The symbol used before displaying the version of Elixir/Erlang.
style "bold purple" モゞュヌルのスタむルです。
format 'via [$symbol$version \(OTP $otp_version\)]($style) ' The format for the module elixir.
disabled false Disables the elixir module.

倉数

倉数 蚭定䟋 説明
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. The module will be shown if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "🌳 " A format string representing the symbol of Elm.
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) "

環境倉数

The env_var module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:

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

オプション

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

Erlang

The erlang module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
symbol " " The symbol used before displaying the version of erlang.
style "bold red" モゞュヌルのスタむルです。
format "via [$symbol$version]($style) " moduleのフォヌマットです。
disabled false Disables the erlang module.

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

Gcloud

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

オプション

オプション デフォルト 説明
format 'on [$symbol$account(\($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.
style "bold blue" モゞュヌルのスタむルです。
disabled false Disables the gcloud module.

倉数

倉数 蚭定䟋 説明
region us-central1 The current GCP region
account foo@example.com The current GCP profile
project The current GCP project
active default The active config name written in ~/.config/gcloud/active_config
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋

Display account and project

# ~/.config/starship.toml

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

Display active config name only

# ~/.config/starship.toml

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

Display account and aliased region

# ~/.config/starship.toml

[gcloud]
symbol = "🇬 "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"

Git ブランチ

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

オプション

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

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

蚭定䟋

# ~/.config/starship.toml

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

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 衚瀺されるgitコミットハッシュの長さです。
format "[\\($hash\\)]($style) [\\($tag\\)]($style)" moduleのフォヌマットです。
style "bold green" モゞュヌルのスタむルです。
only_detached true 切り離されたHEAD状態のずきのみgit commit hashを衚瀺したす
tag_disabled true Disables showing tag info in git_commit module.
tag_symbol "🏷 " Tag symbol prefixing the info shown
disabled false Disables the git_commit module.

倉数

倉数 蚭定䟋 説明
hash b703eb3 The current git commit hash
style* オプション style の倀をミラヌする

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

蚭定䟋

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "

Git の進行状態

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 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 の状態

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

オプション

オプション デフォルト 説明
format '([\[$all_status$ahead_behind\]]($style) )' git_status のデフォルトフォヌマット
conflicted "=" このブランチにはマヌゞの競合がありたす。
ahead "⇡" aheadのフォヌマット
behind "⇣" behindのフォヌマット
diverged "⇕" divergedのフォヌマット
untracked "?" The format of untracked
stashed "$" The format of stashed
modified "!" The format of modified
staged "+" The format of staged
renamed "»" The format of renamed
deleted "✘" The format of deleted
style "bold red" モゞュヌルのスタむルです。
disabled false git_statusモゞュヌルを無効にしたす。

倉数

The following variables can be used in format:

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

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

The following variables can be used in diverged:

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

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

倉数 説明
count ファむルの数を衚瀺したす。

蚭定䟋

# ~/.config/starship.toml

[git_status]
conflicted = "🏳"
ahead = "🏎💚"
behind = "😰"
diverged = "😵"
untracked = "🀷‍"
stashed = "📊"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"

Show ahead/behind count of the branch being tracked

# ~/.config/starship.toml

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

Golang

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

  • カレントディレクトリにgo.modファむルが含たれおいる
  • カレントディレクトリにgo.sumファむルが含たれおいる
  • カレントディレクトリにglide.yamlファむルが含たれおいる
  • カレントディレクトリにGopkg.ymlファむルが含たれおいる
  • カレントディレクトリにGopkg.lockファむルが含たれおいる
  • カレントディレクトリに.go-versionファむルが含たれおいる
  • カレントディレクトリにGodepsファむルが含たれおいる
  • カレントディレクトリに.goの拡匵子のファむルが含たれおいる

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "🐹 " A format string representing the symbol of Go.
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. The module will be shown if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
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) "

ホスト名

The hostname module shows the system 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 module will be shown if any of the following conditions are met:

  • カレントディレクトリに pom.xml, build.gradle.kts, build.sbt ,もしくは.java-versionが含たれおいる
  • カレントディレクトリに拡匵子が.java, .class, .gradle, もしくは.jarのファむルが含たれおいる

オプション

オプション デフォルト 説明
format "via [${symbol}${version}]($style) " moduleのフォヌマットです。
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 = "🌟 "

ゞョブ

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists.

オプション

オプション デフォルト 説明
threshold 1 超過した堎合、ゞョブの数を衚瀺したす。
format "[$symbol$number]($style) " moduleのフォヌマットです。
symbol "✩" A format string representing the number of jobs.
style "bold blue" モゞュヌルのスタむルです。
disabled false jobsモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

Julia

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

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "ஃ " A format string representing the symbol of Julia.
style "bold purple" モゞュヌルのスタむルです。
disabled false juliaモゞュヌルを無効にしたす。

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

[julia]
symbol = "∎ "

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.

::: tip

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

:::

オプション

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

倉数

倉数 蚭定䟋 説明
context starship-cluster The current kubernetes context
namespace starship-namespace If set, the current 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"

改行

The line_break module separates the prompt into two lines.

オプション

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

蚭定䟋

# ~/.config/starship.toml

[line_break]
disabled = true

Lua

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

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "🌙 " A format string representing the symbol of Lua.
style "bold blue" モゞュヌルのスタむルです。
lua_binary "lua" Configures the lua binary that Starship executes when getting the version.
disabled false Disables the lua module.

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

Memory Usage

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

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

::: tip

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

:::

オプション

オプション デフォルト 説明
threshold 75 この閟倀を超えない限り、メモリ䜿甚率は衚瀺されたせん。
format `"via $symbol [${ram}( ${swap})]($style) "`
symbol "🐏" The symbol used before displaying the memory usage.
style "bold dimmed white" モゞュヌルのスタむルです。
disabled true Disables the memory_usage module.

倉数

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

The hg_branch module shows the active branch 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]($style) " moduleのフォヌマットです。
truncation_length 2^63 - 1 Truncates the hg branch name to X 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. The module will be shown if any of the following conditions are met:

  • The current directory contains a nim.cfg file
  • The current directory contains a file with the .nim extension
  • The current directory contains a file with the .nims extension
  • The current directory contains a file with the .nimble extension

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " The format for the module
symbol "👑 " The symbol used before displaying the version of Nim.
style "bold yellow" モゞュヌルのスタむルです。
disabled false Disables the nim module.

倉数

倉数 蚭定䟋 説明
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. 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.
disabled false Disables the nix_shell module.

倉数

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

NodeJS

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

  • The current directory contains a package.json file
  • The current directory contains a .node-version file
  • The current directory contains a node_modules directory
  • The current directory contains a file with the .js, .mjs or .cjs extension
  • The current directory contains a file with the .ts extension

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "⬢ " A format string representing the symbol of NodeJS.
style "bold green" モゞュヌルのスタむルです。
disabled false Disables the nodejs module.

 Variables

倉数 蚭定䟋 説明
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 module will be shown if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " The format string for the module.
symbol "🐫 " The symbol used before displaying the version of OCaml.
style "bold yellow" モゞュヌルのスタむルです。
disabled false Disables the ocaml module.

倉数

倉数 蚭定䟋 説明
version v4.10.0 The version of ocaml
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 Version

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

  • npm – The npm package version is extracted from the package.json present in the current directory
  • cargo – The cargo package version is extracted from the Cargo.toml present in the current directory
  • poetry – The poetry package version is extracted from the pyproject.toml present in the current directory
  • composer – The composer package version is extracted from the composer.json present in the current directory
  • gradle – The gradle package version is extracted from the build.gradle present
  • julia - The package version is extracted from the Project.toml present
  • mix - The mix package version is extracted from the mix.exs present
  • helm - The helm chart version is extracted from the Chart.yaml present
  • maven - The maven package version is extracted from the pom.xml present

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "📊 " The symbol used before displaying the version the package.
style "bold 208" モゞュヌルのスタむルです。
display_private false Enable displaying version for packages marked as private.
disabled false Disables the package module.

倉数

倉数 蚭定䟋 説明
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 module will be shown if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " The format string for the module.
symbol "🐪 " The symbol used before displaying the version of Perl
style "bold 149" モゞュヌルのスタむルです。
disabled false Disables the perl module.

倉数

倉数 蚭定䟋 説明
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. The module will be shown if any of the following conditions are met:

  • The current directory contains a composer.json file
  • The current directory contains a .php-version file
  • The current directory contains a .php file

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "🐘 " The symbol used before displaying the version of PHP.
style "147 bold" モゞュヌルのスタむルです。
disabled false Disables the php module.

倉数

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

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

蚭定䟋

# ~/.config/starship.toml

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

PureScript

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

  • The current directory contains a spago.dhall file
  • The current directory contains a *.purs files

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "<=> " The symbol used before displaying the version of PureScript.
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

python モゞュヌルは珟圚むンストヌルされおいるPythonのバヌゞョンず アクティブ化されおいる堎合は珟圚のPython仮想環境を衚瀺したす。

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

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

オプション

オプション デフォルト 説明
format 'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) ' moduleのフォヌマットです。
symbol "🐍 " A format string representing the symbol of Python
style "yellow bold" モゞュヌルのスタむルです。
pyenv_version_name false Use pyenv to get Python version
pyenv_prefix pyenv Prefix before pyenv version display, only used if pyenv is used
scan_for_pyfiles true If false, Python files in the current directory will not show this module.
python_binary python Configures the python binary that Starship executes when getting the version.
disabled false Disables the python module.

倉数

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

Using the python3 binary to get the version.

Note - The python_binary variable changes the binary that Starship executes to get the version of Python, it doesn't change the arguments that are used.

# ~/.config/starship.toml

[python]
python_binary = "python3"

Ruby

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

  • The current directory contains a Gemfile file
  • The current directory contains a .ruby-version file
  • The current directory contains a .rb file

オプション

オプション デフォルト 説明
format "via [$symbol$version]($style) " moduleのフォヌマットです。
symbol "💎 " A format string representing the symbol of Ruby.
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

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のフォヌマットです。
symbol "🊀 " A format string representing the symbol of Rust
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)"

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

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 "✖" A format string representing the symbol for the status
style "bold red" モゞュヌルのスタむルです。
disabled true Disables the status module.

倉数

倉数 蚭定䟋 説明
status 127 The exit code of the last command
symbol オプション 蚘号 の倀をミラヌする
style* オプション style の倀をミラヌする

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

蚭定䟋


# ~/.config/starship.toml

[status]
style = "bg:blue"
symbol = "💣 "
format = '[\[$symbol$status\]]($style) '
disabled = false

Swift

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のフォヌマットです。
symbol "🐊 " A format string representing the symbol of Swift
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. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below. The module will be shown if any of the following conditions are met:

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

オプション

オプション デフォルト 説明
format "via [$symbol$workspace]($style) " The format string for the module.
symbol "💠 " A format string shown before the terraform workspace.
style "bold 105" モゞュヌルのスタむルです。
disabled false Disables the terraform module.

倉数

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

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

蚭定䟋

With Version

# ~/.config/starship.toml

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

Without version

# ~/.config/starship.toml

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

Time

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

::: tip

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

:::

オプション

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

オプション

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

Zig

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

オプション

オプション デフォルト 説明
symbol "↯ " The symbol used before displaying the version of Zig.
style "bold yellow" モゞュヌルのスタむルです。
format "via [$symbol$version]($style) " moduleのフォヌマットです。
disabled false Disables the zig module.

倉数

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

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

:::

オプション

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

倉数

倉数 説明
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
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"

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