設定

🔥Starshipの開発は現在も進んでいます。 多くの新しいオプションが今後のリリースで利用可能になります。

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

$ touch ~/.config/starship.toml

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

# Don't print a new line at the start of the prompt
add_newline = false

# Replace the "❯" symbol in the prompt with "➜"
[character]      # The name of the module we are configuring is "character"
symbol = "➜"     # The "symbol" segment is being set to "➜"

# Disable the package module, hiding it from the prompt completely
[package]
disabled = true

用語

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

セグメント: モジュールを構成する小さなサブコンポーネントです。 たとえば、「nodejs」モジュールの「symbol」セグメントには、バージョン番号の前に表示される文字が含まれています(デフォルト: ⬢)。

以下はNode モジュールの表現です。 次の例では、「シンボル」と「バージョン」はその中のセグメントです。 すべてのモジュールには、デフォルトの端末色であるprefixとsuffixもあります。

[prefix]      [symbol]     [version]    [suffix]
 "via "         "⬢"        "v10.4.1"       ""

スタイルの設定

Starshipのほとんどのモジュールでは、表示スタイルを設定できます。 これは、設定を指定する文字列であるエントリ(style)で行われます。 スタイル文字列の例とその機能を次に示します。 完全な構文の詳細については、詳細は 高度な設定を参照してください 。

  • "fg:green bg:blue" は、青色の背景に緑色のテキストを設定します
  • "bg:blue fg:bright-green" は、青色の背景に明るい緑色のテキストを設定します
  • "bold fg:27" は、 ANSIカラー 27の太字テキストを設定します
  • "underline bg:#bf5700" は、焦げたオレンジ色の背景に下線付きのテキストを設定します
  • "bold italic fg:purple"は、紫色の太字斜体のテキストを設定します
  • "" はすべてのスタイルを明示的に無効にします

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

プロンプト

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

オプション

変数 デフォルト 説明
add_newline true プロンプトの開始前に新しい行を追加します。
prompt_order link プロンプトモジュールを出力する順序を設定します。
scan_timeout 30 Timeout for starship to scan files (in milliseconds).

設定例

# ~/.config/starship.toml

# Disable the newline at the start of the prompt
add_newline = false
# Overwrite a default_prompt_order and  use custom prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10

デフォルトのプロンプト表示順

デフォルトのprompt_orderは、空の場合、またはprompt_orderが指定されていない場合に、プロンプトにモジュールが表示される順序を定義するために使用されます。 デフォルトは次のとおりです。

prompt_order = [
    "username",
    "hostname",
    "kubernetes",
    "directory",
    "git_branch",
    "git_state",
    "git_status",
    "package",
    "dotnet",
    "golang",
    "java",
    "nodejs",
    "python",
    "ruby",
    "rust",
    "nix_shell",
    "conda",
    "memory_usage",
    "aws",
    "env_var",
    "cmd_duration",
    "line_break",
    "jobs",
    "battery",
    "time",
    "character",
]

AWS

aws モジュールは現在のAWSプロファイルが表示されます。 これは ~/.aws/config に記述されている AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE 環境変数に基づいています。

オプション

変数 デフォルト 説明
symbol "☁️ " 現在のAWSプロファイルを表示する前に表示される記号です。
style "bold yellow" モジュールのスタイルです。
disabled false awsモジュールを無効にします。

設定例

# ~/.config/starship.toml

[aws]
style = "bold blue"
symbol = "🅰 "

バッテリー

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

オプション

変数 デフォルト 説明
full_symbol "•" バッテリーが満タンのときに表示される記号です。
charging_symbol "⇡" バッテリーの充電中に表示される記号です。
discharging_symbol "⇣" バッテリーが放電しているときに表示される記号です。
display link モジュールの閾値とスタイルを表示します。
disabled false batteryモジュールを無効にします。
いくつかのまれなバッテリー状態のオプションもあります。
変数 説明
unknown_symbol バッテリー状態が不明なときに表示される記号です。
empty_symbol バッテリーが空のときに表示される記号です。

オプションを指定しない限り、バッテリーの状態がunknownもしくはemptyになった場合にインジケーターは非表示になります。

設定例

# ~/.config/starship.toml

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

バッテリーの表示

display</ 0> オプションを使用して、バッテリーインジケーターを表示するタイミング(閾値)と外観(スタイル)を定義します。 <code>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つの方法で行うことができます。 後者はuse_symbol_for_statustrue設定されている場合にのみ行われます。

オプション

変数 デフォルト 説明
symbol "❯" プロンプトでテキストを入力する前に使用される記号です。
error_symbol "✖" 前のコマンドが失敗した場合にテキスト入力の前に使用される記号です。
use_symbol_for_status false シンボルを変更してエラーステータスを示します。
vicmd_symbol "❮" シェルがvimの通常モードである場合、プロンプトのテキスト入力の前に使用される記号です。
style_success "bold green" 最後のコマンドが成功した場合に使用されるスタイルです。
style_failure "bold red" 最後のコマンドが失敗した場合に使用されるスタイルです。
disabled false characterモジュールを無効にします。

設定例

# ~/.config/starship.toml

[character]
symbol = "➜"
error_symbol = "✗"
use_symbol_for_status = true

コマンド実行時間

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

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 時間を表示する最短期間です。
prefix took コマンド実行時間の直前に表示する文字列です。
style "bold yellow" モジュールのスタイルです。
disabled false cmd_durationモジュールを無効にします。

設定例

# ~/.config/starship.toml

[cmd_duration]
min_time = 4
prefix = "underwent "

Conda

$CONDA_DEFAULT_ENVが設定されている場合、condaモジュールは現在のcondaの環境を表示します。 Note: これはconda自身の プロンプト修飾子 を抑制しません。conda config --set changeps1 False で実行することができます。

オプション

変数 デフォルト 説明
symbol "C " 環境名の直前に使用されるシンボルです。
style "bold green" モジュールのスタイルです。
disabled false condaモジュールを無効にします。

設定例

# ~/.config/starship.toml

[conda]
style = "dimmed green"

ディレクトリ

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リポジトリのルートに切り捨てるかどうかです。
style "bold cyan" モジュールのスタイルです。
disabled false directoryモジュールを無効にします。
このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。
変数 デフォルト 説明
fish_style_pwd_dir_length 0 fish shellのpwdパスロジックを適用するときに使用する文字数です。
use_logical_path true OSからのパスの代わりに、シェル(PWD) によって提供される論理パスを表示します。

設定例

# ~/.config/starship.toml

[directory]
truncation_length = 8

Dotnet

dotnet モジュールはカレントディレクトリに関係する.NET Core SDKのバージョンを表示します。 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 of the following files are present in the current directory: global.json, project.json, *.sln, *.csproj, *.fsproj, *.xproj. You'll also need the .NET Core command-line tools installed in order to use it correctly.

内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 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.

オプション

変数 デフォルト 説明
symbol •NET " dotnetのバージョンを表示する前に使用される記号です。
style "bold blue" モジュールのスタイルです。
heuristic true より高速なバージョン検出を使用して、starshipの動作を維持します。
disabled false dotnetモジュールを無効にします。

設定例

# ~/.config/starship.toml

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

環境変数

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

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

オプション

変数 デフォルト 説明
symbol 環境変数を表示する前に使用される記号です。
variable 表示される環境変数です。
default 上のvariableが定義されていない場合に表示されるデフォルトの値です。
prefix "" 変数の直前に表示するprefixです。
suffix "" 変数の直後に表示するsuffixです。
style "dimmed black" モジュールのスタイルです。
disabled false env_varモジュールを無効にします。

設定例

# ~/.config/starship.toml

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

Git ブランチ

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

オプション

変数 デフォルト 説明
symbol " " 現在のディレクトリのリポジトリのブランチ名の前に使用されるシンボルです。
truncation_length 2^63 - 1 gitブランチをX書記素に切り捨てます。
truncation_symbol "…" ブランチ名切り捨てられていることを示すための記号です。 記号なしに「」も使用できます。
style "bold purple" モジュールのスタイルです。
disabled false git_branchモジュールを無効にします。

設定例

# ~/.config/starship.toml

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

Git の進行状態

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

オプション

変数 デフォルト 説明
rebase "REBASING" rebase進行中に表示されるテキストです。
merge "MERGING" merge進行中に表示されるテキストです。
revert "REVERTING" revert進行中に表示されるテキストです。
cherry_pick "CHERRY-PICKING" cherry-pick進行中に表示されるテキストです。
bisect "BISECTING" disect進行中に表示されるテキストです。
am "AM" apply-mailbox (git am)の進行中に表示されるテキストです。
am_or_rebase "AM/REBASE" あいまいなapply-mailboxまたはrebaseが進行中のときに表示されるテキストです。
progress_divider "/" 現在の進行量と合計進行量を分ける記号またはテキストです。 (例: " of ""3 of 10" )
style "bold yellow" モジュールのスタイルです。
disabled false git_stateモジュールを無効にします。

設定例

# ~/.config/starship.toml

[git_state]
progress_divider = " of "
cherry_pick = "🍒 PICKING"

Git の状態

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

オプション

変数 デフォルト 説明
conflicted "=" このブランチにはマージの競合があります。
conflicted_count link Show and style the number of conflicts.
ahead "⇡" このブランチは、追跡されるブランチよりも先にあります。
behind "⇣" このブランチは、追跡されているブランチの背後にあります。
diverged "⇕" このブランチは、追跡されているブランチから分岐しています。
untracked "?" 作業ディレクトリに追跡されていないファイルがあります。
untracked_count link Show and style the number of untracked files.
stashed "$" ローカルリポジトリ用のスタッシュが存在します。
modified "!" 作業ディレクトリにファイルの変更があります。
modified_count link Show and style the number of modified files.
staged "+" 新しいファイルがステージング領域に追加されました。
staged_count link Show and style the number of files staged files.
renamed "»" 名前が変更されたファイルがステージング領域に追加されました。
renamed_count link Show and style the number of renamed files.
deleted "✘" ファイルの削除がステージング領域に追加されました。
deleted_count link Show and style the number of deleted files.
show_sync_count false 追跡されているブランチの先行/後方カウントを表示します。
prefix [ このモジュールの先頭に表示される文字列です。
suffix ] このモジュールの末尾に表示される文字列です。
style "bold red" モジュールのスタイルです。
disabled false git_statusモジュールを無効にします。

Git Status Counts

変数 デフォルト 説明
enabled false Show the number of files
style Optionally style the count differently than the module

設定例

# ~/.config/starship.toml

[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"

Golang

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

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

オプション

変数 デフォルト 説明
symbol "🐹 " Golangのバージョンを表示する前に使用される記号です。
style "bold cyan" モジュールのスタイルです。
disabled false golangモジュールを無効にします。

設定例

# ~/.config/starship.toml

[golang]
symbol = "🏎💨 "

ホスト名

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

オプション

変数 デフォルト 説明
ssh_only true SSHセッションに接続されている場合にのみホスト名を表示します。
prefix "" ホスト名の直前に表示するprefixです。
suffix "" ホスト名の直後に表示するsuffixです。
trim_at "." この文字が最初にマッチするまでをホスト名と認識します。 "."は最初の. までをホスト名として認識します。 ""を指定した場合トリムしません。
style "bold dimmed green" モジュールのスタイルです。
disabled false hostnameモジュールを無効にします。

設定例

# ~/.config/starship.toml

[hostname]
ssh_only = false
prefix = "⟪"
suffix = "⟫"
trim_at = ".companyname.com"
disabled = false

ジョブ

jobsモジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 1つ以上のジョブがある、またはthresholdに指定した値以上にジョブがある場合は実行中のジョブの数を表示します。

オプション

変数 デフォルト 説明
symbol "✦" ジョブの数を表示する前に使用される記号です。
threshold 1 超過した場合、ジョブの数を表示します。
style "bold blue" モジュールのスタイルです。
disabled false jobsモジュールを無効にします。

設定例

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

Kubernetes

現在のKubernetesコンテキスト名と、設定されている場合は、kubeconfigファイルに基づいてネームスペースを表示します。 The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut. $KUBECONFIG 環境変数が設定されている場合、モジュールはそれを使用します ~/.kube/config は使用しません。

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

オプション

変数 デフォルト 説明
symbol "☸ " クラスタ情報を表示する前に使用される記号です。
style "bold blue" モジュールのスタイルです。
disabled true Kubernetesモジュールを無効にします。

設定例

# ~/.config/starship.toml

[kubernetes]
symbol = "⛵ "
style = "dim green"
disabled = false

改行

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

オプション

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

設定例

# ~/.config/starship.toml

[line_break]
disabled = true

Nix-shell

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

オプション

変数 デフォルト 説明
use_name false nix-shellの名前を表示します。
impure_msg impure impureメッセージをカスタマイズします。
pure_msg pure pureメッセージをカスタマイズします。
style "bold red" モジュールのスタイルです。
disabled false nix_shellモジュールを無効にします。

設定例

# ~/.config/starship.toml

[nix_shell]
disabled = true
use_name = true
impure_msg = "impure shell"
pure_msg = "pure shell"

メモリ使用量

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

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

::: tip

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

:::

オプション

変数 デフォルト 説明
show_percentage false メモリ使用量を割合で表示します。
show_swap true Display swap usage if total swap is non-zero.
threshold 75 この閾値を超えない限り、メモリ使用率は表示されません。
symbol "🐏 " メモリ使用率を表示する前に使用される記号です。
style "bold dimmed white" モジュールのスタイルです。
disabled true memory_usageモジュールを無効にします。

設定例

# ~/.config/starship.toml

[memory_usage]
show_percentage = true
show_swap = true
threshold = -1
symbol = " "
style = "bold dimmed green"

Java

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

  • カレントディレクトリにpom.xml, build.gradle,もしくはbuild.sbtが含まれている
  • カレントディレクトリに拡張子が.java, .class, もしくは.jarのファイルが含まれている

オプション

変数 デフォルト 説明
symbol "☕ " Javaのバージョンを表示する前に使用される記号です。
style "dimmed red" モジュールのスタイルです。
disabled false Javaモジュールを無効にします。

設定例

# ~/.config/starship.toml

[java]
symbol = "🌟 "

NodeJS

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

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

オプション

変数 デフォルト 説明
symbol "⬢ " NodeJSのバージョンを表示する前に使用される記号です。
style "bold green" モジュールのスタイルです。
disabled false nodejsモジュールを無効にします。

設定例

# ~/.config/starship.toml

[nodejs]
symbol = "🤖 "

パッケージのバージョン

packageモジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 このモジュールは現在、 npmcargo 、およびpoetryパッケージをサポートしています。

  • npmnpmパッケージバージョンは、現在のディレクトリにあるpackage.jsonから抽出されます
  • cargocargoパッケージバージョンは、現在のディレクトリにあるCargo.tomlから抽出されます。
  • poetrypoetryパッケージバージョンは、現在のディレクトリにあるpyproject.tomlから抽出されます

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

オプション

変数 デフォルト 説明
symbol "📦 " パッケージのバージョンを表示する前に使用される記号です。
style "bold red" モジュールのスタイルです。
disabled false packageモジュールを無効にします。

設定例

# ~/.config/starship.toml

[package]
symbol = "🎁 "

Python

pythonモジュールは、現在インストールされているPythonのバージョンを示します。

pyenvversionnametrueに設定されている場合 、pyenvでのバージョン名が表示されます 。

それ以外の場合は、 python --versionバージョン番号が表示され、アクティブになっている場合は現在のPython仮想環境が表示されます。

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

  • カレントディレクトリに.python-versionファイルが含まれている
  • カレントディレクトリにrequirements.txtファイルが含まれている
  • カレントディレクトリにpyproject.tomlファイルが含まれている
  • カレントディレクトリに.pyの拡張子のファイルが含まれている
  • カレントディレクトリにPipfileファイルが含まれている
  • カレントディレクトリにtox.iniファイルが含まれている

オプション

変数 デフォルト 説明
symbol "🐍 " Pythonのバージョンを表示する前に使用される記号です。
pyenv_version_name false pyenvを使用してPythonバージョンを取得します
pyenv_prefix "pyenv " pyenvバージョン表示の前のprefix(デフォルトの表示はpyenv MY_VERSION)です
style "bold yellow" モジュールのスタイルです。
disabled false pythonモジュールを無効にします。

設定例

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true
pyenv_prefix = "foo "

Ruby

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

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

オプション

変数 デフォルト 説明
symbol "💎 " Rubyのバージョンを表示する前に使用される記号です。
style "bold red" モジュールのスタイルです。
disabled false rubyモジュールを無効にします。

設定例

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

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

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

オプション

変数 デフォルト 説明
symbol "🦀 " Rustのバージョンを表示する前に使用される記号です。
style "bold red" モジュールのスタイルです。
disabled false rustモジュールを無効にします。

設定例

# ~/.config/starship.toml

[rust]
symbol = "⚙️ "

時刻

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

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

オプション

変数 デフォルト 説明
use_12hr false 12時間のフォーマットを有効にします。
format この表の下を参照してください 時刻のフォーマットに使用されるクロノフォーマット文字列 です。
style bold yellow モジュールのスタイルです。
disabled true 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.

use_12hrtrueの場合、formatのデフォルトは"%r"です。 それ以外の場合、デフォルトは"%T"です。 formatを手動で設定すると、use_12hrの設定が上書きされます。

設定例

# ~/.config/starship.toml

[time]
disabled = false
format = "🕙[ %T ]"
utc_time_offset = -5

ユーザー名

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

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

オプション

変数 デフォルト 説明
style_root "bold red" ユーザーがrootのときに使用されるスタイルです。
style_user "bold yellow" 非rootユーザーに使用されるスタイルです。
show_always false usernameモジュールを常に表示します。
disabled false usernameモジュールを無効にします。

設定例

# ~/.config/starship.toml

[username]
disabled = true