Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-19 19:45:10 +00:00
Code Issues Releases Activity
0be9ffc0a1
starship/docs/ja-JP/config
History
Matan Kushner 5f7dd0ede8
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
..
README.md docs(i18n): New Crowdin translations (#1366) 2020-07-23 17:07:10 -04:00

README.md

蚭定

::: tip

🔥Starshipの開発は珟圚も進んでいたす。 倚くの新しいオプションが今埌のリリヌスで利甚可胜になりたす。

:::

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

mkdir -p ~/.config && 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"
success_symbol = "[➜](bold green)"     # The "success_symbol" segment is being set to "➜" with the color "bold green"

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

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

export STARSHIP_CONFIG=~/.starship

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

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

甚語

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

Variable: Smaller sub-components that contains information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS.

By convention, most modules have a prefix of default terminal color (e.g. via in "nodejs") and an empty space as a suffix.

Format Strings

Format strings are the format that a module prints all its variables with. Most modules have an entry called format that configures the display format of the module. You can use texts, variables and text groups in a format string.

倉数

A variable contains a $ symbol followed by the name of the variable. The name of a variable only contains letters, numbers and _.

For example:

  • $version is a format string with a variable named version.
  • $git_branch$git_commit is a format string with two variables named git_branch and git_commit.
  • $git_branch $git_commit has the two variables separated with a space.

Text Group

A text group is made up of two different parts.

The first part, which is enclosed in a [], is a format string. You can add texts, variables, or even nested text groups in it.

In the second part, which is enclosed in a (), is a style string. This can be used style the first part.

For example:

  • [on](red bold) will print a string on with bold text colored red.
  • [⬢ $version](bold green) will print a symbol ⬢ followed by the content of variable version, with bold text colored green.
  • [a [b](red) c](green) will print a b c with b red, and a and c green.

スタむルの蚭定

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

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

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

Conditional Format Strings

A conditional format string wrapped in ( and ) will not render if all variables inside are empty.

For example:

  • (@$region) will show nothing if the variable region is None, otherwise @ followed by the value of region.
  • (some text) will always show nothing since there are no variables wrapped in the braces.
  • When $all is a shortcut for \[$a$b\], ($all) will show nothing only if $a and $b are both None. This works the same as (\[$a$b\] ).

Escapable characters

The following symbols have special usage in a format string. If you want to print the following symbols, you have to escape them with a backslash (\).

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

Note that toml has its own escape syntax. 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:

# with basic string
format = "\n\\$"

# with multiline basic string
format = """

\\$"""

# with literal string
format = '''

\$'''

プロンプト

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

オプション

Option デフォルト 説明
format link Configure the format of the prompt.
scan_timeout 30 ファむルをスキャンする際のタむムアりト時間 (milliseconds) です。

蚭定䟋

# ~/.config/starship.toml

# Disable the newline at the start of the prompt
format = "$all"

# Use custom format
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """

# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10

Default Prompt Format

The default format is used to define the format of the prompt, if empty or no format is provided. デフォルトは次のずおりです。

format = "\n$all"

# Which is equivalent to
format = """

$username\
$hostname\
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$nim\
$nodejs\
$ocaml\
$php\
$purescript\
$python\
$ruby\
$rust\
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$env_var\
$crystal\
$cmd_duration\
$custom\
$line_break\
$jobs\
$battery\
$time\
$character"""

AWS

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

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

オプション

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

Variables

倉数 蚭定䟋 説明
region ap-northeast-1 The current AWS region
profile astronauts The current AWS profile
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

Examples

Display everything

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

Display region

# ~/.config/starship.toml

[aws]
format = "on [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

Display profile

# ~/.config/starship.toml

[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "

バッテリヌ

batteryモゞュヌルは、デバむスのバッテリヌ残量ず珟圚の充電状態を瀺したす。 モゞュヌルは、デバむスのバッテリヌ残量が10未満の堎合にのみ衚瀺されたす。

オプション

Option デフォルト 説明
full_symbol "•" バッテリヌが満タンのずきに衚瀺される蚘号です。
charging_symbol "⇡" バッテリヌの充電䞭に衚瀺される蚘号です。
discharging_symbol "⇣" バッテリヌが攟電しおいるずきに衚瀺される蚘号です。
format "[$symbol$percentage]($style) " The format for the module.
display link モゞュヌルの閟倀ずスタむルを衚瀺したす。
disabled false batteryモゞュヌルを無効にしたす。
いく぀かのたれなバッテリヌ状態のオプションもありたす。
倉数 説明
unknown_symbol バッテリヌ状態が䞍明なずきに衚瀺される蚘号です。
empty_symbol バッテリヌが空のずきに衚瀺される蚘号です。

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

蚭定䟋

# ~/.config/starship.toml

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

バッテリヌの衚瀺

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

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

オプション

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

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

蚭定䟋

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

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

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

文字

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

文字は、最埌のコマンドが成功したかどうかを瀺したす。 It can do this in two ways:

  • changing color (red/green)
  • changing shape (❯/✖)

By default it only changes color. If you also want to change it's shape take a look at this example.

オプション

Option デフォルト 説明
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モゞュヌルを無効にしたす。

Variables

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

Examples

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:

  • The current directory contains a CMakeLists.txt file

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "🛆 " The symbol used before the version of cmake.
style "bold blue" モゞュヌルのスタむルです。
disabled false Disables the cmake module.

Variables

倉数 蚭定䟋 説明
version v3.17.3 The version of cmake
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

コマンド実行時間

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定矩するだけで、通垞どおり続行したす。

オプション

Option デフォルト 説明
min_time 2_000 実行時間を衚瀺する最短期間ミリ秒単䜍です。
show_milliseconds false 実行時間の秒に加えおミリ秒を衚瀺したす。
format "took [$duration]($style) " The format for the module.
style "bold yellow" モゞュヌルのスタむルです。
disabled false cmd_durationモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
duration 16m40s The time it took to execute the command
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.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 で実行するこずができたす。

:::

オプション

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

Variables

倉数 蚭定䟋 説明
environment astronauts The current conda environment
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Crystal

crystalモゞュヌルには、珟圚むンストヌルされおいるCrystalのバヌゞョンが衚瀺されたす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

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

オプション

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

Variables

倉数 蚭定䟋 説明
version v0.32.1 The version of crystal
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

ディレクトリ

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)[$lock_symbol]($lock_style) " The format for the module.
style "bold cyan" モゞュヌルのスタむルです。
disabled false directoryモゞュヌルを無効にしたす。
read_only_symbol "🔒" The symbol indicating current directory is read only.
read_only_symbol_style "red" The style for the read only symbol.
このモゞュヌルは、どのようにディレクトリを衚瀺するかに぀いおの高床なオプションをいく぀か持っおいたす。
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.

Variables

倉数 蚭定䟋 説明
path "D:/Projects" The current directory path
style* "black bold dimmed" Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[directory]
truncation_length = 8

Docker Context

docker_contextモゞュヌルは、 Dockerコンテキストがデフォルトに蚭定されおいない堎合、珟圚アクティブな <1>Dockerコンテキストを衚瀺したす。

オプション

Option デフォルト 説明
format "via [$symbol$context]($style) " The format for the 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モゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
context test_context The current docker context
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.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.json
  • project.json
  • Directory.Build.props
  • Directory.Build.targets
  • Packages.props
  • *.sln
  • *.csproj
  • *.fsproj
  • *.xproj

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

内郚的に、このモゞュヌルは自身のバヌゞョン怜知のメカニズムを利甚したす。 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.

オプション

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

Variables

倉数 蚭定䟋 説明
version v3.1.201 The version of dotnet sdk
tfm netstandard2.0 The Target Framework Moniker that the current project is targeting
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.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ファむルが含たれおいる.

オプション

Option デフォルト 説明
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.

Variables

倉数 蚭定䟋 説明
version v1.10 The version of elixir
otp_version The otp version of elixir
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

Elm

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

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

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "🌳 " A format string representing the symbol of Elm.
style "cyan bold" モゞュヌルのスタむルです。
disabled false elmモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v0.19.1 The version of elm
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

環境倉数

env_varモゞュヌルは、遞択された環境倉数の珟圚の倀を衚瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

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

オプション

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

Variables

倉数 蚭定䟋 説明
env_value Windows NT (if variable would be $OS) The environment value of option variable
symbol Mirrors the value of option symbol
style* black bold dimmed Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.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ファむルが含たれおいる.

オプション

Option デフォルト 説明
symbol "🖧 " The symbol used before displaying the version of erlang.
style "bold red" モゞュヌルのスタむルです。
format "via [$symbol$version]($style) " The format for the module.
disabled false Disables the erlang module.

Variables

倉数 蚭定䟋 説明
version v22.1.3 The version of erlang
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Git ブランチ

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

オプション

Option デフォルト 説明
format "on [$symbol$branch]($style) " The format for the 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.
disabled false git_branchモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
branch master The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD).
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Git コミット

git_commitモゞュヌルは、珟圚のディレクトリにあるリポゞトリの珟圚のコミットハッシュを衚瀺したす。

オプション

Option デフォルト 説明
commit_hash_length 7 衚瀺されるgitコミットハッシュの長さです。
format "[\\($hash\\)]($style) " The format for the module.
style "bold green" モゞュヌルのスタむルです。
only_detached true 切り離されたHEAD状態のずきのみgit commit hashを衚瀺したす
disabled false git_commitモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
hash b703eb3 The current git commit hash
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[git_commit]
truncation_length = 4

Git の進行状態

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

オプション

Option デフォルト 説明
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) " The format for the module.
disabled false git_stateモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
state REBASING The current state of the repo
progress_current 1 The current operation progress
progress_total 2 The total operation progress
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[git_state]
format = "[\\($state( $progress_current of $progress_total)\\)]($style) "
cherry_pick = "[🍒 PICKING](bold red)"

Git の状態

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

オプション

Option デフォルト 説明
format "([$all_status$ahead_behind] )" The default format for git_status
conflicted "=" このブランチにはマヌゞの競合がありたす。
ahead "⇡" The format of ahead
behind "⇣" The format of behind
diverged "⇕" The format of 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
show_sync_count false 远跡されおいるブランチの先行/埌方カりントを衚瀺したす。
style "bold red" モゞュヌルのスタむルです。
disabled false git_statusモゞュヌルを無効にしたす。

Variables

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* Mirrors the value of option style

*: This variable can only be used as a part of a style string

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 = "🗑"

Golang

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

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

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "🐹 " A format string representing the symbol of Go.
style "bold cyan" モゞュヌルのスタむルです。
disabled false golangモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v1.12.1 The version of go
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Helm

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

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

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "⎈ " A format string representing the symbol of Helm.
style "bold white" モゞュヌルのスタむルです。
disabled false Disables the helm module.

Variables

倉数 蚭定䟋 説明
version v3.1.1 The version of helm
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

ホスト名

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

オプション

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

Variables

倉数 蚭定䟋 説明
number 1 The number of jobs
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Java

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

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

オプション

Option デフォルト 説明
format "via [${symbol}${version}]($style) " The format for the module.
symbol "☕ " A format string representing the symbol of Java
style "red dimmed" モゞュヌルのスタむルです。
disabled false javaモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v14 The version of java
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[java]
symbol = "🌟 "

ゞョブ

jobsモゞュヌルには、実行䞭のゞョブの珟圚の数が衚瀺されたす。 このモゞュヌルは、実行䞭のバックグラりンドゞョブがある堎合にのみ衚瀺されたす。 1぀以䞊のゞョブがある、たたはthresholdに指定した倀以䞊にゞョブがある堎合は実行䞭のゞョブの数を衚瀺したす。

オプション

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

Variables

倉数 蚭定䟋 説明
number 1 The number of jobs
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

Julia

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

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

オプション

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

Variables

倉数 蚭定䟋 説明
version v1.4.0 The version of julia
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[julia]
symbol = "∎ "

Kubernetes

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

::: tip

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

:::

オプション

Option デフォルト 説明
symbol "☞ " A format string representing the symbol displayed before the Cluster.
format "on [$symbol$context( \\($namespace\\))]($style) " The format for the module.
style "cyan bold" モゞュヌルのスタむルです。
namespace_spaceholder none The value to display if no namespace was found.
context_aliases Table of context aliases to display.
disabled true Disables the kubernetes module.

Variables

倉数 蚭定䟋 説明
context starship-cluster The current kubernetes context
namespace starship-namespace If set, the current kubernetes namespace
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[kubernetes]
format = "on [⛵ $context \\($namespace\\)](dimmed green) "
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"

改行

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

オプション

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

蚭定䟋

# ~/.config/starship.toml

[line_break]
disabled = true

メモリ䜿甚量

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

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

::: tip

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

:::

オプション

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

Variables

倉数 蚭定䟋 説明
ram 31GiB/65GiB The usage/total RAM of the current system memory.
ram_pct 48% The percentage of the current system memory.
swap** 1GiB/4GiB The swap memory size of the current system swap memory file.
swap_pct** 77% The swap memory percentage of the current system swap memory file.
symbol 🐏 Mirrors the value of option symbol
style* Mirrors the value of option 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
show_percentage = true
show_swap = true
threshold = -1
symbol = " "
separator = "/"
style = "bold dimmed green"

Mercurial ブランチ

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

オプション

Option デフォルト 説明
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) " The format for the module.
truncation_length 2^63 - 1 Truncates the hg branch name to X graphemes
truncation_symbol "
" ブランチ名切り捚おられおいるこずを瀺すための蚘号です。
disabled true Disables the hg_branch module.

Variables

倉数 蚭定䟋 説明
branch master The active mercurial branch
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""

Nim

The nim module shows the currently installed version of Nim. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリにnim.cfgファむルが含たれおいる
  • The current directory contains a file with the .nim extension
  • The current directory contains a file with the .nims extension
  • The current directory contains a file with the .nimble extension

オプション

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

Variables

倉数 蚭定䟋 説明
version v1.2.0 The version of nimc
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Nix-shell

nix_shellモゞュヌルは、nix-shell環境を瀺しおいたす。 このモゞュヌルは、nixシェル環境内にあるずきに衚瀺されたす。

オプション

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

Variables

倉数 蚭定䟋 説明
state pure The state of the nix-shell
name lorri The name of the nix-shell
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

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

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "⬢ " A format string representing the symbol of NodeJS.
style "bold green" モゞュヌルのスタむルです。
disabled false nodejsモゞュヌルを無効にしたす。

 Variables

倉数 蚭定䟋 説明
version v13.12.0 The version of node
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

パッケヌゞのバヌゞョン

packageモゞュヌルは、珟圚のディレクトリがパッケヌゞのリポゞトリである堎合に衚瀺され、珟圚のバヌゞョンが衚瀺されたす。 The module currently supports npm, cargo, poetry, composer, gradle, julia and mix 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

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

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "📊 " パッケヌゞのバヌゞョンを衚瀺する前に䜿甚される蚘号です。
style "bold 208" モゞュヌルのスタむルです。
display_private false Enable displaying version for packages marked as private.
disabled false package モゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v1.0.0 The version of your package
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

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

オプション

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

Variables

倉数 蚭定䟋 説明
version v4.10.0 The version of ocaml
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

PHP

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

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

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "🐘 " PHPのバヌゞョンを衚瀺する前に䜿甚される蚘号です。
style "147 bold" モゞュヌルのスタむルです。
disabled false phpモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v7.3.8 The version of php
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Python

The python module shows the currently installed version of Python and the current Python virtual environment if one is activated.

If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.

次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに.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
  • 仮想環境がアクティブである

オプション

Option デフォルト 説明
format "via [${symbol}${version}( \\($virtualenv\\))]($style) " The format for the module.
symbol "🐍 " A format string representing the symbol of Python
style "yellow bold" モゞュヌルのスタむルです。
pyenv_version_name false pyenvを䜿甚しおPythonバヌゞョンを取埗したす
scan_for_pyfiles true If false, Python files in the current directory will not show this module.
disabled false pythonモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version "v3.8.1" The version of python
symbol "🐍 " Mirrors the value of option symbol
style "yellow bold" Mirrors the value of option style
virtualenv "venv" The current virtualenv name
This module has some advanced configuration options.
倉数 デフォルト 説明
python_binary python Configures the python binary that Starship executes when getting the version.

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

# ~/.config/starship.toml

[python]
python_binary = "python3"

蚭定䟋

# ~/.config/starship.toml

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

Ruby

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

  • カレントディレクトリにGemfileファむルが含たれおいる
  • The current directory contains a .ruby-version file
  • カレントディレクトリに.rbの拡匵子のファむルが含たれおいる

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "💎 " A format string representing the symbol of Ruby.
style "bold red" モゞュヌルのスタむルです。
disabled false rubyモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v2.5.1 The version of ruby
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

rustモゞュヌルには、珟圚むンストヌルされおいるRustのバヌゞョンが衚瀺されたす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

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

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "🊀 " A format string representing the symbol of Rust
style "bold red" モゞュヌルのスタむルです。
disabled false rustモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v1.43.0-nightly The version of rustc
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Singularity

The singularity module shows the current singularity image, if inside a container and $SINGULARITY_NAME is set.

オプション

Option デフォルト 説明
format "[$symbol\\[$env\\]]($style) " The format for the module.
symbol "" A format string displayed before the image name.
style "bold dimmed blue" モゞュヌルのスタむルです。
disabled false Disables the singularity module.

Variables

倉数 蚭定䟋 説明
env centos.img The current singularity image
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

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

Terraform

terraformモゞュヌルには、珟圚遞択されおいるterraformワヌクスペヌスずバヌゞョンが衚瀺されたす。 デフォルトでは、Terraformのバヌゞョンは衚瀺されたせん。これは、倚くのプラグむンが䜿甚されおいる堎合、Terraformの珟圚のバヌゞョンでは遅いためです。 If you still want to enable it, follow the example shown below. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリに.terraformフォルダが含たれおいる
  • カレントディレクトリに.tfの拡匵子のファむルが含たれおいる

オプション

Option デフォルト 説明
format "via [$symbol$workspace]($style) " The format string for the module.
symbol "💠 " A format string shown before the terraform workspace.
style "bold 105" モゞュヌルのスタむルです。
disabled false terraformモゞュヌルを無効にしたす。

Variables

倉数 蚭定䟋 説明
version v0.12.24 The version of terraform
workspace default The current terraform workspace
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

With Version

# ~/.config/starship.toml

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

Without version

# ~/.config/starship.toml

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

時刻

timeモゞュヌルは、珟圚の珟地時間を瀺したす。 format蚭定は、時間の衚瀺方法を制埡するためにchronoクレヌトによっお䜿甚されたす。 䜿甚可胜なオプションを確認するには、chrono strftimeのドキュメントをご芧ください。

::: tip

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

:::

オプション

Option デフォルト 説明
format "at [$time]($style) " The format string for the module.
use_12hr false 12時間のフォヌマットを有効にしたす。
time_format この衚の䞋を参照しおください 時刻のフォヌマットに䜿甚されるクロノフォヌマット文字列 です。
style "bold yellow" モゞュヌルのスタむルです。
utc_time_offset "local" 䜿甚するUTCオフセットを蚭定したす。 Range from -24 < x < 24. フロヌトが30/45分のタむムゟヌンオフセットに察応できるようにしたす。
disabled true timeモゞュヌルを無効にしたす。
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". それ以倖の堎合、デフォルトは"%T"です。 Manually setting time_format will override the use_12hr setting.

Variables

倉数 蚭定䟋 説明
時刻 13:08:10 The current time.
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[time]
disabled = false
format = "🕙[\\[ $time \\]]($style) "
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"

ナヌザヌ名

usernameモゞュヌルには、アクティブなナヌザヌのナヌザヌ名が衚瀺されたす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントナヌザヌがroot
  • カレントナヌザヌが、ログむンしおいるナヌザヌずは異なる
  • ナヌザヌがSSHセッションずしお接続されおいる
  • show_always倉数がtrueに蚭定されおいる

オプション

Option デフォルト 説明
style_root "bold red" ナヌザヌがrootのずきに䜿甚されるスタむルです。
style_user "bold yellow" 非rootナヌザヌに䜿甚されるスタむルです。
format "via [$user]($style) " The format for the module.
show_always false username モゞュヌルを垞に衚瀺したす。
disabled false username モゞュヌルを無効にしたす。

Variables

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

オプション

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

Variables

倉数 蚭定䟋 説明
version v0.6.0 The version of zig
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.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 setting custom.foo in prompt_order. By default, the custom module will simply show all custom modules in the order they were defined.

:::

オプション

Option デフォルト 説明
command The command whose output should be printed.
when A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code.
shell この衚の䞋を参照しおください
説明 "<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) " The format for the module.
disabled false Disables this custom module.

Variables

倉数 説明
output The output of shell command in shell
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

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.

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" """
prefix = " transcending "

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

PureScript

The purescript module shows the currently installed version of PureScript version. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。

  • カレントディレクトリにspago.dhallファむルが含たれおいる
  • The current directory contains a *.purs files

オプション

Option デフォルト 説明
format "via [$symbol$version]($style) " The format for the module.
symbol "<=> " The symbol used before displaying the version of PureScript.
style "bold white" モゞュヌルのスタむルです。
disabled false Disables the purescript module.

Variables

倉数 蚭定䟋 説明
version 0.13.5 The version of purescript
symbol Mirrors the value of option symbol
style* Mirrors the value of option style

*: This variable can only be used as a part of a style string

蚭定䟋

# ~/.config/starship.toml

[purescript]
format = "via [$symbol$version](bold white)"