126 KiB
設定
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のバージョンを表示します。
Variable: Smaller sub-components that contain information provided by the module. 例えば、"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 variableregionisNone, otherwise@followed by the value of region.(some text)will always show nothing since there are no variables wrapped in the braces.- When
$allis a shortcut for\[$a$b\],($all)will show nothing only if$aand$bare bothNone. 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\
$kotlin\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$ruby\
$rust\
$swift\
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$custom\
$cmd_duration\
$line_break\
$lua\
$jobs\
$battery\
$time\
$status\
$character"""
AWS
aws モジュールは現在のAWSプロファイルが表示されます。 これは ~/.aws/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 |
"" |
バッテリーが放電しているときに表示される記号です。 |
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 オプションを使用して、バッテリーインジケーターを表示するタイミング（閾値）と外観（スタイル）を定義します。 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.txtfile - The current directory contains a
CMakeCache.txtfile
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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
$CONDA_DEFAULT_ENVが設定されている場合、condaモジュールは現在のcondaの環境を表示します。
::: tip
Note: これはconda自身の プロンプト修飾子 を抑制しません。conda config --set changeps1 False で実行することができます。
:::
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
truncation_length |
1 |
環境がconda create -p [path]で作成された場合、環境パスが切り捨てられるディレクトリ数。 0は切り捨てがないことを意味します。 directoryもご覧ください。 |
symbol |
"🅒 " |
環境名の直前に使用されるシンボルです。 |
style |
"bold green" |
モジュールのスタイルです。 |
format |
"via [$symbol$environment]($style) " |
moduleのフォーマットです。 |
ignore_base |
true |
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
crystalモジュールには、現在インストールされているCrystalのバージョンが表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
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 current directory contains a file with
.dartextension - The current directory contains a
.dart_tooldirectory - カレントディレクトリに
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) "
ディレクトリ
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 |
"🔒" |
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: "…/" |
このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。
| 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
docker_contextモジュールは、 Dockerコンテキストがデフォルトに設定されていない場合、現在アクティブな <1>Dockerコンテキストを表示します。
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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
dotnet モジュールはカレントディレクトリに関係する.NET Core SDKのバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール 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.jsonproject.jsonDirectory.Build.propsDirectory.Build.targetsPackages.props*.sln*.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 |
"[$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. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
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
elmモジュールは、現在インストールされているElmのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
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) "
環境変数
env_varモジュールは、選択された環境変数の現在の値を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
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. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
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 ブランチ
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 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 |
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 コミット
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 |
git_commitモジュールを無効にします。 |
変数
| 変数 | 設定例 | 説明 |
|---|---|---|
| hash | b703eb3 |
The current git commit hash |
| style* | オプション style の値をミラーする |
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "
Git の進行状態
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 の状態
git_statusモジュールは、現在のディレクトリのリポジトリの状態を表すシンボルを表示します。
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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
golangモジュールは、現在インストールされているGolangのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
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. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
helmfile.yamlファイルが含まれている - The current directory contains a
Chart.yamlfile
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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) "
ホスト名
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
javaモジュールは、現在インストールされているJavaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a
pom.xml,build.gradle.kts,build.sbt,.java-version,.deps.edn,project.clj, orbuild.bootfile - The current directory contains a file with the
.java,.class,.gradle,.jar,.clj, or.cljcextension
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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 = "🌟 "
ジョブ
jobsモジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 1つ以上のジョブがある、またはthresholdに指定した値以上にジョブがある場合は実行中のジョブの数を表示します。
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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
juliaモジュールは、現在インストールされているJuliaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
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 = "∴ "
Kotlin
The kotlin module shows the currently installed version of Kotlin. 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a
.ktor a.ktsfile
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
format |
"via [$symbol$version]($style) " |
moduleのフォーマットです。 |
symbol |
"🅺 " |
A format string representing the symbol of Kotlin. |
style |
"bold blue" |
モジュールのスタイルです。 |
kotlin_binary |
"kotlin" |
Configures the kotlin binary that Starship executes when getting the version. |
disabled |
false |
Disables the kotlin module. |
変数
| 変数 | 設定例 | 説明 |
|---|---|---|
| version | v1.4.21 |
The version of kotlin |
| symbol | オプション 記号 の値をミラーする |
|
| style* | オプション style の値をミラーする |
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
# ~/.config/starship.toml
[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"
Kubernetes
Displays the current Kubernetes context name and, if set, the namespace 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
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルでdisabledをfalseに設定します。
:::
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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"
改行
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-versionfile - The current directory contains a
luadirectory - The current directory contains a file with the
.luaextension
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
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</ 0>モジュールは、現在のシステムメモリとスワップ使用量を示します。
デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。
::: tip
このモジュールはデフォルトで無効になっています。
有効にするには、設定ファイルでdisabled`を`false`に設定します。
:::
オプション
オプション
デフォルト
説明
threshold75この閾値を超えない限り、メモリ使用率は表示されません。
format`"via $symbol [${ram}(
${swap})]($style) "`
symbol"🐏"メモリ使用率を表示する前に使用される記号です。
style"bold dimmed white"モジュールのスタイルです。
disabledtruememory_usageモジュールを無効にします。
変数
変数
設定例
説明
ram
31GiB/65GiBThe usage/total RAM of the current system memory.
ram_pct
48%The percentage of the current system memory.
swap**
1GiB/4GiBThe 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 ブランチ
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_length2^63 - 1Truncates the hg branch name to X graphemes
truncation_symbol"…"ブランチ名切り捨てられていることを示すための記号です。
disabledtrueDisables the hg_branch module.
変数
変数
設定例
説明
branch
masterThe 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 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"モジュールのスタイルです。
disabledfalseDisables the nim module.
変数
変数
設定例
説明
version
v1.2.0The version of nimc
symbol
オプション 記号 の値をミラーする
style*
オプション style の値をミラーする
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
Nix-shell
nix_shellモジュールは、nix-shell環境を示しています。 このモジュールは、nixシェル環境内にあるときに表示されます。
オプション
オプション
デフォルト
説明
format'via [$symbol$state( \($name\))]($style) 'moduleのフォーマットです。
symbol"❄️ "A format string representing the symbol of nix-shell.
style"bold blue"モジュールのスタイルです。
impure_msg"impure"A format string shown when the shell is impure.
pure_msg"pure"A format string shown when the shell is pure.
disabledfalsenix_shellモジュールを無効にします。
変数
変数
設定例
説明
state
pureThe state of the nix-shell
name
lorriThe 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
nodejsモジュールは、現在インストールされているNodeJSのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
package.jsonファイルが含まれている
- The current directory contains a
.node-version 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のフォーマットです。
symbol"⬢ "A format string representing the symbol of NodeJS.
style"bold green"モジュールのスタイルです。
disabledfalsenodejsモジュールを無効にします。
not_capable_stylebold redThe style for the module when an engines property in Packages.json does not match the NodeJS version.
Variables
変数
設定例
説明
version
v13.12.0The 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]($style) "The format string for the module.
symbol"🐫 "The symbol used before displaying the version of OCaml.
style"bold yellow"モジュールのスタイルです。
disabledfalseDisables the ocaml module.
変数
変数
設定例
説明
version
v4.10.0The 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"モジュールのスタイルです。
disabledfalseDisables the OpenStack module.
変数
変数
設定例
説明
cloud
corpThe current OpenStack cloud
project
devThe 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, cargo, poetry, composer, gradle, julia, mix and helm packages.
- npm –
npmパッケージバージョンは、現在のディレクトリにあるpackage.jsonから抽出されます
- cargo –
cargoパッケージバージョンは、現在のディレクトリにあるCargo.tomlから抽出されます。
- poetry –
poetryパッケージバージョンは、現在のディレクトリにあるpyproject.tomlから抽出されます
- composer –
composerパッケージバージョンは、現在のディレクトリにあるcomposer.jsonから抽出されます
- 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
⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。
オプション
オプション
デフォルト
説明
format"is [$symbol$version]($style) "moduleのフォーマットです。
symbol"📦 "パッケージのバージョンを表示する前に使用される記号です。
style"bold 208"モジュールのスタイルです。
display_privatefalseEnable displaying version for packages marked as private.
disabledfalsepackage モジュールを無効にします。
変数
変数
設定例
説明
version
v1.0.0The 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.
symbol"🐪 "The symbol used before displaying the version of Perl
style"bold 149"モジュールのスタイルです。
disabledfalseDisables the perl module.
変数
変数
設定例
説明
version
v5.26.1The version of perl
symbol
オプション 記号 の値をミラーする
style*
オプション style の値をミラーする
設定例
# ~/.config/starship.toml
[perl]
format = "via [🦪 $version]($style) "
PHP
phpモジュールは、現在インストールされているPHPのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a
composer.json file
- The current directory contains a
.php-version file
- カレントディレクトリに
.phpの拡張子のファイルが含まれている
オプション
オプション
デフォルト
説明
format"via [$symbol$version]($style) "moduleのフォーマットです。
symbol"🐘 "PHPのバージョンを表示する前に使用される記号です。
style"147 bold"モジュールのスタイルです。
disabledfalsephpモジュールを無効にします。
変数
変数
設定例
説明
version
v7.3.8The 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 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"モジュールのスタイルです。
disabledfalseDisables the purescript module.
変数
変数
設定例
説明
version
0.13.5The 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.
次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
.python-versionファイルが含まれている
- カレントディレクトリに
requirements.txtファイルが含まれている
- カレントディレクトリに
pyproject.tomlファイルが含まれている
- The current directory contains a file with the
.py extension (and scan_for_pyfiles is true)
- カレントディレクトリに
Pipfileファイルが含まれている
- カレントディレクトリに
tox.iniファイルが含まれている
- カレントディレクトリに
setup.pyファイルが含まれている
- The current directory contains a
__init__.py file
- 仮想環境がアクティブである
オプション
オプション
デフォルト
説明
format'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) 'moduleのフォーマットです。
symbol"🐍 "A format string representing the symbol of Python
style"yellow bold"モジュールのスタイルです。
pyenv_version_namefalsepyenvを使用してPythonバージョンを取得します
pyenv_prefixpyenvPrefix before pyenv version display, only used if pyenv is used
scan_for_pyfilestrueIf false, Python files in the current directory will not show this module.
python_binary["python", "python3, "python2"]Configures the python binaries that Starship should executes when getting the version.
disabledfalsepythonモジュールを無効にします。
::: 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"
Ruby
rubyモジュールは、現在インストールされているRubyのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
Gemfileファイルが含まれている
- The current directory contains a
.ruby-version file
- カレントディレクトリに
.rbの拡張子のファイルが含まれている
オプション
オプション
デフォルト
説明
format"via [$symbol$version]($style) "moduleのフォーマットです。
symbol"💎 "A format string representing the symbol of Ruby.
style"bold red"モジュールのスタイルです。
disabledfalserubyモジュールを無効にします。
変数
変数
設定例
説明
version
v2.5.1The version of ruby
symbol
オプション 記号 の値をミラーする
style*
オプション style の値をミラーする
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
Rust
rustモジュールには、現在インストールされているRustのバージョンが表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
Cargo.tomlファイルが含まれている
- カレントディレクトリに
.rsの拡張子のファイルが含まれている
オプション
オプション
デフォルト
説明
format"via [$symbol$version]($style) "moduleのフォーマットです。
symbol"🦀 "A format string representing the symbol of Rust
style"bold red"モジュールのスタイルです。
disabledfalserustモジュールを無効にします。
変数
変数
設定例
説明
version
v1.43.0-nightlyThe 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.
オプション
オプション
デフォルト
説明
threshold2Display threshold.
format"[$symbol$shlvl]($style) "moduleのフォーマットです。
symbol"↕️ "The symbol used to represent the SHLVL.
repeatfalseCauses symbol to be repeated by the current SHLVL amount.
style"bold yellow"モジュールのスタイルです。
disabledtrueDisables the shlvl module.
変数
変数
設定例
説明
shlvl
3The 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"モジュールのスタイルです。
disabledfalseDisables the singularity module.
変数
変数
設定例
説明
env
centos.imgThe 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に設定します。
:::
オプション
オプション
デフォルト
説明
format[$symbol$status]($style)The format of the module
symbol"✖"The symbol displayed on program error
not_executable_symbol"🚫"The symbol displayed when file isn't executable
not_found_symbol"🔍"The symbol displayed when the command can't be found
sigint_symbol"🧱"The symbol displayed on SIGINT (Ctrl + c)
signal_symbol"⚡"The symbol displayed on any signal
style"bold red"モジュールのスタイルです。
recognize_signal_codetrueEnable signal mapping from exit code
map_symbolfalseEnable symbols mapping from exit code
disabledtrueDisables the status module.
変数
変数
設定例
説明
status
127The exit code of the last command
int
127The exit code of the last command
common_meaning
ERRORMeaning of the code if not a signal
signal_number
9Signal number corresponding to the exit code, only if signalled
signal_name
KILLName of the signal corresponding to the exit code, only if signalled
maybe_int
7Contains the exit code number when no meaning has been found
symbol
オプション 記号 の値をミラーする
style*
オプション style の値をミラーする
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
# ~/.config/starship.toml
[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) '
map_symbol = true
disabled = false
Swift
The swift module shows the currently installed version of Swift. 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a
Package.swift file
- The current directory contains a file with the
.swift extension
オプション
オプション
デフォルト
説明
format"via [$symbol$version]($style) "moduleのフォーマットです。
symbol"🐦 "A format string representing the symbol of Swift
style"bold 202"モジュールのスタイルです。
disabledfalseDisables the swift module.
変数
変数
設定例
説明
version
v5.2.4The 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. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに
.terraformフォルダが含まれている
- 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"モジュールのスタイルです。
disabledfalseterraformモジュールを無効にします。
変数
変数
設定例
説明
version
v0.12.24The version of terraform
workspace
defaultThe 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
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルでdisabledをfalseに設定します。
:::
オプション
オプション
デフォルト
説明
format"at [$time]($style) "The format string for the module.
use_12hrfalse12時間のフォーマットを有効にします。
time_formatこの表の下を参照してください
時刻のフォーマットに使用されるクロノフォーマット文字列 です。
style"bold yellow"モジュールのスタイルです。
utc_time_offset"local"使用するUTCオフセットを設定します。 Range from -24 < x < 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。
disabledtruetimeモジュールを無効にします。
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.
変数
変数
設定例
説明
時刻
13:08:10The 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"
ユーザー名
The username module shows active user's username. 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントユーザーがroot
- カレントユーザーが、ログインしているユーザーとは異なる
- ユーザーがSSHセッションとして接続されている
show_always変数がtrueに設定されている
::: tip
SSH connection is detected by checking environment variables SSH_CONNECTION, SSH_CLIENT, and SSH_TTY. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
:::
オプション
オプション
デフォルト
説明
style_root"bold red"ユーザーがrootのときに使用されるスタイルです。
style_user"bold yellow"非rootユーザーに使用されるスタイルです。
format"[$user]($style) in "moduleのフォーマットです。
show_alwaysfalseusername モジュールを常に表示します。
disabledfalseusername モジュールを無効にします。
変数
変数
設定例
説明
style"red bold"Mirrors the value of option style_root when root is logged in and style_user otherwise.
user"matchai"The currently logged-in user ID.
設定例
# ~/.config/starship.toml
[username]
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true
Zig
The zig module shows the currently installed version of Zig. 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a
.zig file
オプション
オプション
デフォルト
説明
symbol"↯ "The symbol used before displaying the version of Zig.
style"bold yellow"モジュールのスタイルです。
format"via [$symbol$version]($style) "moduleのフォーマットです。
disabledfalseDisables the zig module.
変数
変数
設定例
説明
version
v0.6.0The 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!
:::
オプション
オプション
デフォルト
説明
commandThe command whose output should be printed. The command will be passed on stdin to the shell.
whenA shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code.
shellこの表の下を参照してください
説明"<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のフォーマットです。
disabledfalseDisables 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", "-"]