Matan Kushner高度な設定
Starship は汎用性の高いシェルですが、時には特定の処理を行うために starship.toml を編集する以上のことをする必要があります。 このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。 このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。
[!WARNING] The configurations in this section are subject to change in future releases of Starship.
PowerShell の TransientPrompt
直前に出力されたプロンプトを置き換えることができます。 プロンプトの内容全てが常に必要ではない時に役立ちます。 To enable
this, run Enable-TransientPrompt in the shell session. To make it permanent, put
this statement in your $PROFILE. Transience can be disabled on-the-fly with
Disable-TransientPrompt.
By default, the left side of input gets replaced with >. To customize this,
define a new function called Invoke-Starship-TransientFunction. For example, to
display Starship's character module here, you would do
function Invoke-Starship-TransientFunction {
&starship module character
}
Invoke-Expression (&starship init powershell)
Enable-TransientPrompt
Cmd の TransientPrompt と TransientRightPrompt
Clink を使うと直前に出力したプロント文字列をカスタマイズできます。 プロンプトの内容全てが常に必要ではない時に役立ちます。 Clink を使うと直前に出力したプロント文字列をカスタマイズできます。 全ての情報が必要では無い時に役に立ちます。 有効化するには次のコマンドを実行します。 clink set prompt.transient <value> 。 <value> には次のいずれかの値を指定します。
always: 直前に出力したプロンプト文字列を常に置換します。same_dir: 作業ディレクトリが同じなら、直前に出力したプロンプト文字列を置換します。off: プロンプト文字列を置換しません(無効化します)。
この操作が必要なのは1度だけです。 この操作が必要なのは1度だけです。 自分の starship.lua を次のように編集すると、プロンプト文字列の左側や右側に出力する文字列を変更できます。
- By default, the left side of input gets replaced with
>. To customize this, define a new function calledstarship_transient_prompt_func. This function receives the current prompt as a string that you can utilize. For example, to display Starship'scharactermodule here, you would do
function starship_transient_prompt_func(prompt)
return io.popen("starship module character"
.." --keymap="..rl.getvariable('keymap')
):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
- デフォルトでは、入力した文字列の右側は空です。 To customize this, define a new
function called
starship_transient_rprompt_func. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
function starship_transient_rprompt_func(prompt)
return io.popen("starship module time"):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
Fish の TransientPrompt と TransientRightPrompt
直前に出力されたプロンプトを置き換えることができます。 プロンプトの内容全てが常に必要ではない時に役立ちます。 To enable
this, run enable_transience in the shell session. To make it permanent, put
this statement in your ~/.config/fish/config.fish. Transience can be disabled on-the-fly with
disable_transience.
※Fishの場合は、コマンドラインが空ではなく構文的に正しい場合にのみ、transient プロンプトが出力されます。
- By default, the left side of input gets replaced with a bold-green
❯. To customize this, define a new function calledstarship_transient_prompt_func. For example, to display Starship'scharactermodule here, you would do
function starship_transient_prompt_func
starship module character
end
starship init fish | source
enable_transience
- デフォルトでは、入力した文字列の右側は空です。 To customize this, define a new
function called
starship_transient_rprompt_func. For example, to display the time at which the last command was started here, you would do
function starship_transient_rprompt_func
starship module time
end
starship init fish | source
enable_transience
Bash の TransientPrompt と TransientRightPrompt
The Ble.sh framework at v0.4 or higher allows you to replace
the previous-printed prompt with custom strings. プロンプトの内容全てが常に必要ではない時に役立ちます。 バージョン 0.4 以降の ble.sh の枠組みを用いると、直前に表示されたプロンプトを指定の文字列に置き換えることができます。 プロンプトの内容全てが常に必要ではない時に役立ちます。 有効にするには、 ~/.bashrc に bleopt prompt_ps1_transient=<value> を記述してください。
The <value> here is a colon-separated list of always, same-dir and trim.
When prompt_ps1_final is empty and the option prompt_ps1_transient has a non-empty <value>,
the prompt specified by PS1 is erased on leaving the current command line.
If <value> contains a field trim, only the last line of multiline PS1 is
preserved and the other lines are erased. Otherwise, the command line will be
redrawn as if PS1= is specified. When a field same-dir is contained in
<value> and the current working directory is different from the final directory of
the previous command line, this option prompt_ps1_transient is ignored.
左側や右側に transient プロンプトとして出力する文字列を変更するには、以下の変更を ~/.blerc (または ~/.config/blesh/init.sh) に適用してください。
- 入力文字列の左側を何に置き換えるか変更するには、 ble.sh 設定
prompt_ps1_finalを設定します。 例えば Starship のcharacterモジュールをここに表示するには、次のようにします。 For example, to display Starship'scharactermodule here, you would do
bleopt prompt_ps1_final='$(starship module character)'
- 入力文字列の右側を何に置き換えるか変更するには、 ble.sh 設定
prompt_rps1_finalを設定します。 例えば、直前のコマンドを実行した時刻を表示するには次のようにします。 For example, to display the time at which the last command was started here, you would do
bleopt prompt_rps1_final='$(starship module time)'
Cmdのカスタムの事前プロンプトおよび事前実行コマンド
Clinkはプロンプト表示前と実行前にCmd shellコマンドを実行するための非常に柔軟なAPIを提供します。 Starshipからこれを利用するのはとても簡単です。 Make the following changes
to your starship.lua file as per your requirements:
- 関数をプロンプトが描画される直前に実行するためには、新しい関数を定義して
starship_precmd_user_funcに割り当ててください。 例として、ロケットをプロンプトの前に表示させたければ、下記のようにしてください。 This function receives the current prompt as a string that you can utilize. For example, to draw a rocket before the prompt, you would do
function starship_preprompt_user_func(prompt)
print("🚀")
end
load(io.popen('starship init cmd'):read("*a")()
- コマンドが実行される直前に好みの関数を実行するには、
starship_precmd_user_funcという名前で新しい関数を定義してください。 この関数は現在のコマンドライン文字列を再利用できる文字列で受け取ります。 例えば、これから実行されるコマンドを出力するには、以下のようにします。 This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do
function starship_precmd_user_func(line)
print("Executing: "..line)
end
load(io.popen('starship init cmd'):read("*a"))()
Bashのカスタムの事前プロンプトおよび事前実行コマンド
Bashには、他のほとんどのシェルとは違い、正式な preexec / precmd フレームワークを持っていません。 そのため、 bashで完全にカスタマイズ可能なフックを提供することは困難です。 ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。
Because of this, it is difficult to provide fully customizable hooks in bash.
ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。
- To run a custom function right before the prompt is drawn, define a new
function and then assign its name to
starship_precmd_user_func. For example, to draw a rocket before the prompt, you would do
function blastoff(){
echo "🚀"
}
starship_precmd_user_func="blastoff"
- コマンドの直前に関数を実行するために、
DEBUGトラップの仕組みを使うことができます。 ただし、Starship を初期化する_前_に DEBUG シグナルをトラップしなければいけません! However, you must trap the DEBUG signal before initializing Starship! Starship は DEBUGトラップの値を保護できますが、 starship の起動後にトラップが上書きされると、いくつかの機能は壊れてしまうでしょう。
function blastoff(){
echo "🚀"
}
trap blastoff DEBUG # Trap DEBUG *before* running starship
set -o functrace
eval $(starship init bash)
set +o functrace
PowerShell のカスタム事前プロンプトおよび事前実行コマンド
PowerShell は、他のほとんどのシェルと違い、正式な preexec/precmd の枠組みを持ちません。 そのため、powershellで完全にカスタマイズ可能なフックを提供することは困難です。 ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。
Because of this, it is difficult to provide fully customizable hooks in powershell.
ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。
Invoke-Starship-PreCommand という名前の関数を作成してください。
function Invoke-Starship-PreCommand {
$host.ui.Write("🚀")
}
ウィンドウタイトルの変更
いくつかのシェルプロンプトはあなたのためにウィンドウのタイトルを自動的に変更します(例えば、カレントディレクトリを反映するために)。 特に Fish はデフォルトで変更を行います。 Starship はこれに対応しませんが、この機能を bash, zsh, cmd, powershell に追加することは簡単です。 特に Fish はデフォルトで変更を行います。
Starship does not do this, but it's fairly straightforward to add this
functionality to bash, zsh, cmd or powershell.
まず、ウィンドウのタイトルを変更する関数を定義してください（ bash も zsh も同様に）
function set_win_title(){
echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
}
タイトルをカスタマイズするために変数を利用することができます ($USER 、 $HOSTNAME、 $PWD が一般的です)。
bash では関数を starship の precmd 関数としてセットしてください。
starship_precmd_user_func="set_win_title"
zshでは関数を precmd_functions の配列に追加してください。
precmd_functions+=(set_win_title)
もし結果に満足したら、永続化のためそれぞれの行をシェルの設定ファイル (~/.bashrc もしくは ~/.zshrc) に追加してください。
たとえば、現在のディレクトリをターミナルタブのタイトルに表示したい場合は、 ~/.bashrcまたは~/.zshrcに以下のスニペットを追加します。
function set_win_title(){
echo -ne "\033]0; $(basename "$PWD") \007"
}
starship_precmd_user_func="set_win_title"
Cmd では、 starship_preprompt_user_func 関数を使用してウィンドウのタイトルを変更できます。
function starship_preprompt_user_func(prompt)
console.settitle(os.getenv('USERNAME').."@"..os.getenv('COMPUTERNAME')..": "..os.getcwd())
end
load(io.popen('starship init cmd'):read("*a"))()
PowerShell でも Invoke-Starship-PreCommand という名前の関数を作成することで、同様の出力を設定できます。
# edit $PROFILE
function Invoke-Starship-PreCommand {
$host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
}
Invoke-Expression (&starship init powershell)
右プロンプトの有効化
シェルによっては、入力と同じ行にレンダリングされる右プロンプトをサポートしています。 Starship can
set the content of the right prompt using the right_format option. シェルによっては、入力と同じ行にレンダリングされる右プロンプトをサポートしています。 Starship では right_format オプションを使って右プロンプトの内容を設定できます。 formatで使用できるモジュールはすべてright_formatでも使用できます。 変数$allには、formatやright_formatで明示的に使用されていないモジュールのみが格納されます。 The $all variable will only contain modules
not explicitly used in either format or right_format.
注意: 右プロンプトは入力の場所に続く単一の行です。 注意: 右プロンプトは入力の場所に続く単一の行です。 複数行プロンプトで入力行の上にあるモジュールを右寄せしたいときは、 fill module を参照してください。
right_format は現在、次のシェルでサポートされています: elvish, fish, zsh, xonsh, cmd, nushell, bash
注意: 右プロンプトを Bash で利用するには ble.sh のバージョン 0.4 以降をインストールする必要があります。
設定例
# ~/.config/starship.toml
# 最低限の左プロンプト
format = """$character"""
# 残りのプロンプトの内容を右に寄せる
right_format = """$all"""
次のようなプロンプトが生成されます:
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
When using zsh (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship $fill module. To remove this gap, add the following to your .zshrc:
ZLE_RPROMPT_INDENT=0
継続プロンプト (Continuation Prompt)
一部のシェルは、通常のプロンプトの他に継続プロンプトをサポートしています。 このプロンプトは、ユーザーが不完全な文 (単一の左括弧や引用符など) を確定したときに通常のプロンプトの代わりに表示されます。
Starship では、 contination_prompt オプションを使用して継続プロンプトを設定できます。 既定の継続プロンプトは '[∙](bright-black) ' です。 The default prompt is '[∙](bright-black) '.
注意: contination_prompt には変数を含まないそのまま文字列を設定する必要があります。
注意: 継続プロンプトは次のシェルでのみ使用できます。
bashzshPowerShell
設定例
# ~/.config/starship.toml
# 2つの塗りつぶし右三角を表示する継続プロンプト
continuation_prompt = '▶▶ '
Statusline for Claude Code
Starship supports displaying a custom statusline when running inside Claude Code, Anthropic's CLI tool for interactive coding with Claude. This statusline provides real-time information about your Claude session, including the model being used, context window usage, and session costs.
For more information about the Claude Code statusline feature, see the Claude Code statusline documentation.
Setup
To use Starship as your Claude Code statusline:
- Run
/statuslinein Claude Code and ask it to configure Starship, or manually add the following to your.claude/settings.json:
{
"statusLine": {
"type": "command",
"command": "starship statusline claude-code"
}
}
- Customize the statusline appearance in your
~/.config/starship.toml(see Configuration below)
Overview
When invoked with starship statusline claude-code, Starship receives Claude Code session data via stdin and renders a statusline using a dedicated profile named claude-code.
The profile includes three specialized modules:
claude_model: Displays the current Claude model being usedclaude_context: Shows context window usage with a visual gaugeclaude_cost: Displays session cost and statistics
The default profile format is:
[profiles]
claude-code = "$claude_model$git_branch$claude_context$claude_cost"
設定
You can customize the Claude Code statusline by modifying the claude-code profile and individual module configurations in your ~/.config/starship.toml:
# ~/.config/starship.toml
# Customize the claude-code profile
[profiles]
claude-code = "$claude_model$claude_context$claude_cost"
# Configure individual modules
[claude_model]
format = "[$symbol$model]($style) "
symbol = "🤖 "
style = "bold blue"
[claude_context]
format = "[$gauge $percentage]($style) "
gauge_width = 10
[claude_cost]
format = "[$symbol$cost]($style) "
symbol = "💰 "
Claude Model
The claude_model module displays the current Claude model being used in the session.
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
format |
'[$symbol$model]($style) ' |
module のフォーマットです。 |
symbol |
'🤖 ' |
The symbol shown before the model name. |
style |
'bold blue' |
モジュールのスタイルです。 |
model_aliases |
{} |
Map of model IDs or display names to shorter aliases. Checks ID first, then display name. |
disabled |
false |
Disables the claude_model module. |
変数
| 変数 | 設定例 | 説明 |
|---|---|---|
| model | Claude 3.5 Sonnet |
The display name of the current model |
| model_id | claude-3-5-sonnet |
The model ID |
| symbol | オプション symbol の値をミラーする |
|
| style* | オプション style の値をミラーする |
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
# ~/.config/starship.toml
# Basic customization
[claude_model]
format = "on [$symbol$model]($style) "
symbol = "🧠 "
style = "bold cyan"
# Using model aliases for vendor-specific model names
# You can alias by model ID or display name
[claude_model.model_aliases]
# Alias by vendor model ID (e.g. AWS Bedrock)
"global.anthropic.claude-sonnet-4-5-20250929-v1:0" = "Sonnet 4.5"
# Alias by display name
"Claude Sonnet 4.5 (Vendor Proxy)" = "Sonnet"
Claude Context
The claude_context module displays context window usage as a percentage and visual gauge. The style automatically changes based on configurable thresholds.
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
format |
'[$gauge $percentage]($style) ' |
module のフォーマットです。 |
symbol |
'' |
The symbol shown before the gauge. |
gauge_width |
5 |
The width of the gauge in characters. |
gauge_full_symbol |
'█' |
The symbol used for filled segments of the gauge. |
gauge_partial_symbol |
'▒' |
The symbol used for partial segments of the gauge. |
gauge_empty_symbol |
'░' |
The symbol used for empty segments of the gauge. |
display |
この表の下を参照してください | Threshold and style configurations. |
disabled |
false |
Disables the claude_context module. |
Display
The display option is an array of objects that define thresholds and styles for different usage levels. The module uses the style from the highest matching threshold or hides the module if hidden is true.
| オプション | デフォルト | 説明 |
|---|---|---|
threshold |
0.0 |
The minimum context windows usage percentage to match this configuration |
style |
bold green |
The value of style if this display configuration is matched |
hidden |
false |
Hide this module if this the configuration is matched. |
[[claude_context.display]]
threshold = 0
hidden = true
[[claude_context.display]]
threshold = 30
style = "bold green"
[[claude_context.display]]
threshold = 60
style = "bold yellow"
[[claude_context.display]]
threshold = 80
style = "bold red"
変数
| 変数 | 設定例 | 説明 |
|---|---|---|
| gauge | ██▒░░ |
Visual representation of context usage |
| percentage | 65% |
Context usage as a percentage |
| input_tokens | 45.2k |
Total input tokens in conversation |
| output_tokens | 12.3k |
Total output tokens in conversation |
| curr_input_tokens | 5.1k |
Input tokens from most recent API call |
| curr_output_tokens | 1.2k |
Output tokens from most recent API call |
| curr_cache_creation_tokens | 1.5k |
Cache creation tokens from most recent API call |
| curr_cache_read_tokens | 23.4k |
Cache read tokens from most recent API call |
| total_tokens | 200k |
Total context window size |
| symbol | オプション symbol の値をミラーする |
|
| style* | Mirrors the style from the matching display threshold |
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
Minimal gauge-only display
# ~/.config/starship.toml
[claude_context]
format = "[$gauge]($style) "
gauge_width = 10
Detailed token information
# ~/.config/starship.toml
[claude_context]
format = "[$percentage ($input_tokens in / $output_tokens out)]($style) "
Custom gauge symbols
# ~/.config/starship.toml
[claude_context]
gauge_full_symbol = "▰"
gauge_partial_symbol = ""
gauge_empty_symbol = "▱"
gauge_width = 10
format = "[$gauge]($style) "
Custom thresholds
# ~/.config/starship.toml
[[claude_context.display]]
threshold = 0
style = "bold green"
[[claude_context.display]]
threshold = 50
style = "bold yellow"
[[claude_context.display]]
threshold = 75
style = "bold orange"
[[claude_context.display]]
threshold = 90
style = "bold red"
Claude Cost
The claude_cost module displays the total cost of the current Claude Code session in USD. Like claude_context, it supports threshold-based styling.
オプション
| オプション | デフォルト | 説明 |
|---|---|---|
format |
'[$symbol(\\$$cost)]($style) ' |
module のフォーマットです。 |
symbol |
'💰 ' |
The symbol shown before the cost. |
display |
この表の下を参照してください | Threshold and style configurations. |
disabled |
false |
Disables the claude_cost module. |
Display
The display option is an array of objects that define cost thresholds and styles. The module uses the style from the highest matching threshold or hides the module if hidden is true.
| オプション | デフォルト | 説明 |
|---|---|---|
threshold |
0.0 |
The minimum cost in USD to match this configuration |
style |
bold green |
The value of style if this display configuration is matched |
hidden |
false |
Hide this module if this configuration is matched. |
Default configuration:
[[claude_cost.display]]
threshold = 0.0
hidden = true
[[claude_cost.display]]
threshold = 1.0
style = "bold yellow"
[[claude_cost.display]]
threshold = 5.0
style = "bold red"
変数
| 変数 | 設定例 | 説明 |
|---|---|---|
| cost | 1.23 |
Total session cost in USD (formatted to 2 decimals) |
| duration | 1m 30s |
Total session duration |
| api_duration | 45s |
Total API call duration |
| lines_added | 1.2k |
Total lines of code added |
| lines_removed | 500 |
Total lines of code removed |
| symbol | オプション symbol の値をミラーする |
|
| style* | Mirrors the style from the matching display threshold |
*: この変数はスタイル文字列の一部としてのみ使用できます
設定例
# ~/.config/starship.toml
# Cost with code change statistics
[claude_cost]
format = "[$symbol$cost (+$lines_added -$lines_removed)]($style) "
# Hide module until cost exceeds $0.10
[[claude_cost.display]]
threshold = 0.0
hidden = true
[[claude_cost.display]]
threshold = 0.10
style = "bold yellow"
[[claude_cost.display]]
threshold = 2.0
style = "bold red"
# Show duration information
[claude_cost]
format = "[$symbol$cost ($duration)]($style) "
スタイルの設定
スタイル文字列は空白で区切られた単語のリストです。 大文字小文字を区別しません（例えば、 bold とBoLd は同じだとみなされます）。 それぞれ以下のいずれか一つが該当します。 The words are not case sensitive (i.e. bold and BoLd are considered the same string). それぞれ以下のいずれか一つが該当します。
bolditalicunderlinedimmedinvertedblinkhiddenstrikethroughbg:<color>fg:<color><color>none
where <color> is a color specifier (discussed below). fg:<color> and <color> currently do the same thing, though this may change in the future.
<color> can also be set to prev_fg or prev_bg which evaluates to the previous item's foreground or background color respectively if available or none otherwise.
inverted swaps the background and foreground colors. 文字列中の単語の順序は関係ありません。
none トークンは、文字列中のbg: 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、fg:red none fg:blue と指定した場合、スタイルなしの文字列が作られます。 bg:none は背景色をデフォルトの色にセットするので、fg:red bg:none は red や fg:red と同じ意味になり、bg:green fg:red bg:none も fg:red や red と同じ意味になります。 将来 none を他の単語と一緒に使用することはエラーになるかもしれません。 bg:none sets the background to the default color so fg:red bg:none is equivalent to red or fg:red and bg:green fg:red bg:none is also equivalent to fg:red or red. It may become an error to use none in conjunction with other tokens in the future.
色は以下のいずれか1つを指定できます。
- One of the standard terminal colors:
black,red,green,blue,yellow,purple,cyan,white. You can optionally prefix these withbright-to get the bright version (e.g.bright-white). - A
#followed by a six-digit hexadecimal number.#に続く16進数。 RGB の16進数カラーコードを表します。 - 0-255 までの間の数字。 0-255 までの間の数字。 8-bit ANSI カラーコード を表します。
複数の色が文字色/背景色に指定された際には、最後の指定が優先して選ばれます。
すべてのスタイル文字列がすべての端末で正しく表示できるわけではありません。 特に、端末の変な動作として以下のようなものが知られています。 特に、端末の変な動作として以下のようなものが知られています。
- 多くの端末はデフォルトで
blinkのサポートを無効にしています。 hiddenは iTerm ではサポートされていません。strikethroughは、macOS 既定の Terminal.app ではサポートされていません。