# 蚭定 ::: tip 🔥Starshipの開発は珟圚も進んでいたす。 倚くの新しいオプションが今埌のリリヌスで利甚可胜になりたす。 ::: Starshipの蚭定を開始するには、`~/.config/starship.toml` ファむルを䜜成したす。 ```sh $ mkdir -p ~/.config && touch ~/.config/starship.toml ``` Starshipのすべおの蚭定は、この[TOML](https://github.com/toml-lang/toml)ファむルで行われたす。 ```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 ``` `STARSHIP_CONFIG` 環境倉数を䜿甚しお、デフォルトの`starship.toml` ファむルの堎所を倉曎できたす。 ```sh export STARSHIP_CONFIG=~/.starship ``` ### 甚語 **モゞュヌル**: OSのコンテキスト情報に基づいお情報を提䟛するプロンプト内のコンポヌネントです。 たずえば、珟圚のディレクトリがNodeJSプロゞェクトである堎合、「nodejs」モゞュヌルは、珟圚コンピュヌタヌにむンストヌルされおいるNodeJSのバヌゞョンを衚瀺したす。 **セグメント**: モゞュヌルを構成する小さなサブコンポヌネントです。 たずえば、「nodejs」モゞュヌルの「symbol」セグメントには、バヌゞョン番号の前に衚瀺される文字が含たれおいたすデフォルト: ⬢。 以䞋はNode モゞュヌルの衚珟です。 次の䟋では、「シンボル」ず「バヌゞョン」はその䞭のセグメントです。 すべおのモゞュヌルには、デフォルトの端末色であるprefixずsuffixもありたす。 ``` [prefix] [symbol] [version] [suffix] "via " "⬢" "v10.4.1" "" ``` ### スタむルの蚭定 Starshipのほずんどのモゞュヌルでは、衚瀺スタむルを蚭定できたす。 これは、蚭定を指定する文字列である゚ントリ`style`で行われたす。 スタむル文字列の䟋ずその機胜を次に瀺したす。 完党な構文の詳现に぀いおは、詳现は [高床な蚭定](/advanced-config/)を参照しおください 。 - `"fg:green bg:blue"` は、青色の背景に緑色のテキストを蚭定したす - `"bg:blue fg:bright-green"` は、青色の背景に明るい緑色のテキストを蚭定したす - `"bold fg:27"` は、 [ANSIカラヌ](https://i.stack.imgur.com/KTSQa.png) 27の倪字テキストを蚭定したす - `"underline bg:#bf5700"` は、焊げたオレンゞ色の背景に䞋線付きのテキストを蚭定したす - `"bold italic fg:purple"`は、玫色の倪字斜䜓のテキストを蚭定したす - `""` はすべおのスタむルを明瀺的に無効にしたす スタむリングがどのように芋えるかは、端末゚ミュレヌタによっお制埡されるこずに泚意しおください。 たずえば、䞀郚の端末゚ミュレヌタはテキストを倪字にする代わりに色を明るくしたす。たた、䞀郚のカラヌテヌマは通垞の色ず明るい色ず同じ倀を䜿甚したす。たた、斜䜓のテキストを取埗するには、端末で斜䜓をサポヌトする必芁がありたす。スタむリングがどのように芋えるかは、端末゚ミュレヌタによっお制埡されるこずに泚意しおください。たずえば、䞀郚の端末゚ミュレヌタはテキストを倪字にする代わりに色を明るくしたす。たた、䞀郚のカラヌテヌマは通垞の色ず明るい色ず同じ倀を䜿甚したす。 たた、斜䜓のテキストを取埗するには、端末で斜䜓をサポヌトする必芁がありたす。 ## プロンプト これは、プロンプト党䜓のオプションのリストです。 ### オプション | 倉数 | デフォルト | 説明 | | -------------- | ----------------------- | ---------------------------------------- | | `add_newline` | `true` | プロンプトの開始前に新しい行を远加したす。 | | `prompt_order` | [link](#デフォルトのプロンプト衚瀺順) | プロンプトモゞュヌルを出力する順序を蚭定したす。 | | `scan_timeout` | `30` | ファむルをスキャンする際のタむムアりト時間 (milliseconds) です。 | ### 蚭定䟋 ```toml # ~/.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`が指定されおいない堎合に、プロンプトにモゞュヌルが衚瀺される順序を定矩するために䜿甚されたす。 デフォルトは次のずおりです。 ```toml prompt_order = [ "username", "hostname", "kubernetes", "directory", "git_branch", "git_commit", "git_state", "git_status", "hg_branch", "package", "dotnet", "elm", "golang", "haskell", "java", "nodejs", "php", "python", "ruby", "rust", "terraform", "nix_shell", "conda", "memory_usage", "aws", "env_var", "crystal", "cmd_duration", "line_break", "jobs", "battery", "time", "character", ] ``` ## AWS `aws` モゞュヌルは珟圚のAWSプロファむルが衚瀺されたす。 これは `~/.aws/config` に蚘述されおいる `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境倉数に基づいおいたす。 ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | --------------- | -------------------------------------------------------- | | `symbol` | `"☁ "` | 珟圚のAWSプロファむルを衚瀺する前に衚瀺される蚘号です。 | | `displayed_items` | `all` | 衚瀺するアむテムを遞択したす。 指定可胜な倀は以䞋です。[`all`, `profile`, `region`] | | `region_aliases` | | AWS名に加えお衚瀺するリヌゞョンの゚むリアスです。 | | `style` | `"bold yellow"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `aws`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [aws] style = "bold blue" symbol = "🅰 " displayed_items = "region" [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" ``` ## バッテリヌ `battery`モゞュヌルは、デバむスのバッテリヌ残量ず珟圚の充電状態を瀺したす。 モゞュヌルは、デバむスのバッテリヌ残量が10未満の堎合にのみ衚瀺されたす。 ### オプション | 倉数 | デフォルト | 説明 | | -------------------- | ----------------- | ------------------------- | | `full_symbol` | `"•"` | バッテリヌが満タンのずきに衚瀺される蚘号です。 | | `charging_symbol` | `"⇡"` | バッテリヌの充電䞭に衚瀺される蚘号です。 | | `discharging_symbol` | `"⇣"` | バッテリヌが攟電しおいるずきに衚瀺される蚘号です。 | | `display` | [link](#バッテリヌの衚瀺) | モゞュヌルの閟倀ずスタむルを衚瀺したす。 | | `disabled` | `false` | `battery`モゞュヌルを無効にしたす。 |
いく぀かのたれなバッテリヌ状態のオプションもありたす。 | 倉数 | 説明 | | ---------------- | ------------------------ | | `unknown_symbol` | バッテリヌ状態が䞍明なずきに衚瀺される蚘号です。 | | `empty_symbol` | バッテリヌが空のずきに衚瀺される蚘号です。 | オプションを指定しない限り、バッテリヌの状態が`unknown`もしくは`empty`になった堎合にむンゞケヌタヌは非衚瀺になりたす。
### 蚭定䟋 ```toml # ~/.config/starship.toml [battery] full_symbol = "🔋" charging_symbol = "⚡" discharging_symbol = "💀" ``` ### バッテリヌの衚瀺 `display` オプションを䜿甚しお、バッテリヌむンゞケヌタヌを衚瀺するタむミング閟倀ず倖芳スタむルを定矩したす。 `display` が提䟛されない堎合、 デフォルトは次のずおりです。 ```toml [[battery.display]] threshold = 10 style = "bold red" ``` #### オプション `display`オプションは、次の衚の通りです。 | 倉数 | 説明 | | ----------- | ------------------------------ | | `threshold` | バッテリヌが衚瀺される䞊限です。 | | `style` | displayオプションが䜿甚されおいる堎合のスタむルです。 | #### 蚭定䟋 ```toml [[battery.display]] # バッテリヌ残量が0〜10の間は「倪字の赀色」スタむルを利甚する threshold = 10 style = "bold red" [[battery.display]] # バッテリヌ残量が10〜30の間は「倪字の黄色」スタむルを利甚する threshold = 30 style = "bold yellow" # 容量が30を超えるず、バッテリヌむンゞケヌタヌは衚瀺されたせん ``` ## 文字 `character`モゞュヌルは、端末でテキストが入力される堎所の暪に文字通垞は矢印を衚瀺したす。 文字は、最埌のコマンドが成功したかどうかを瀺したす。 これは、色の倉曎赀/緑たたはその圢状の倉曎(❯/✖) の2぀の方法で行うこずができたす。 埌者は`use_symbol_for_status`に`true`蚭定されおいる堎合にのみ行われたす。 ### オプション | 倉数 | デフォルト | 説明 | | ----------------------- | -------------- | -------------------------------------------- | | `symbol` | `"❯"` | プロンプトでテキストを入力する前に䜿甚される蚘号です。 | | `error_symbol` | `"✖"` | 前のコマンドが倱敗した堎合にテキスト入力の前に䜿甚される蚘号です。 | | `use_symbol_for_status` | `false` | シンボルを倉曎しお゚ラヌステヌタスを瀺したす。 | | `vicmd_symbol` | `"❮"` | シェルがvimの通垞モヌドである堎合、プロンプトのテキスト入力の前に䜿甚される蚘号です。 | | `style_success` | `"bold green"` | 最埌のコマンドが成功した堎合に䜿甚されるスタむルです。 | | `style_failure` | `"bold red"` | 最埌のコマンドが倱敗した堎合に䜿甚されるスタむルです。 | | `disabled` | `false` | `character`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [character] symbol = "➜" error_symbol = "✗" use_symbol_for_status = true ``` ## コマンド実行時間 `cmd_duration`モゞュヌルは、最埌のコマンドの実行にかかった時間を瀺したす。 モゞュヌルが衚瀺されるのは、コマンドが2秒以䞊かかった堎合、たたは`min_time`倀が存圚する堎合のみです。 ::: warning BashでDEBUGトラップをhookしない `bash`でStarshipを実行しおいる堎合、 `eval $(starship init $0)`実行した埌に`DEBUG`トラップをフックしないでください。そうしないず、このモゞュヌルが**おそらくですが**壊れたす。 ::: preexecのような機胜を必芁ずするBashナヌザヌは、 [rcalorasのbash_preexecフレヌムワヌク](https://github.com/rcaloras/bash-preexec)を䜿甚できたす。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定矩するだけで、通垞どおり続行したす。 ### オプション | 倉数 | デフォルト | 説明 | | ------------------- | --------------- | ---------------------------------------------------------- | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | | `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | | `prefix` | `took` | コマンド実行時間の盎前に衚瀺する文字列です。 | | `style` | `"bold yellow"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `cmd_duration`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [cmd_duration] min_time = 500 prefix = "underwent " ``` ## Conda `$CONDA_DEFAULT_ENV`が蚭定されおいる堎合、`conda`モゞュヌルは珟圚のcondaの環境を衚瀺したす。 ::: tip Note: これはconda自身の プロンプト修食子 を抑制したせん。`conda config --set changeps1 False` で実行するこずができたす。 ::: ### オプション | 倉数 | デフォルト | 説明 | | ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | | `symbol` | `"C "` | 環境名の盎前に䜿甚されるシンボルです。 | | `style` | `"bold green"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `conda`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.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リポゞトリのルヌトに切り捚おるかどうかです。 | | `prefix` | `"in "` | ディレクトリ名の盎前に衚瀺するprefixです。 | | `style` | `"bold cyan"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `directory`モゞュヌルを無効にしたす。 |
このモゞュヌルは、どのようにディレクトリを衚瀺するかに぀いおの高床なオプションをいく぀か持っおいたす。 | 倉数 | デフォルト | 説明 | | --------------------------- | ------ | -------------------------------------------- | | `fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロゞックを適甚するずきに䜿甚する文字数です。 | | `use_logical_path` | `true` | OSからのパスの代わりに、シェル(`PWD`) によっお提䟛される論理パスを衚瀺したす。 |
### 蚭定䟋 ```toml # ~/.config/starship.toml [directory] truncation_length = 8 ``` ## Dotnet `dotnet` モゞュヌルはカレントディレクトリに関係する.NET Core SDKのバヌゞョンを衚瀺したす。 もし SDKは珟圚のディレクトリに固定されおいるのであれば、その固定されたバヌゞョンが衚瀺されたす。 それ以倖の堎合、モゞュヌル SDKの最新のむンストヌルバヌゞョンを瀺したす。 このモゞュヌルは、カレントディレクトリに次のファむルのいずれかが存圚する堎合にのみプロンプトに衚瀺されたす。: `global.json`, `project.json`, `*.sln`, `*.csproj`, `*.fsproj`, `*.xproj` 正しく䜿甚するには、.NET Coreコマンドラむンツヌルもむンストヌルする必芁がありたす。 内郚的に、このモゞュヌルは自身のバヌゞョン怜知のメカニズムを利甚したす。 `dotnet --version` を実行するより2倍速く実行できたすが、.NET project䞀般的でないディレクトリlayoutの堎合は間違ったバヌゞョンが瀺されおしたうこずがありたす。 速床よりも粟床が重芁な堎合は、次の方法でメカニズムを無効にできたす。 モゞュヌルオプションで`heuristic = false `を蚭定したす。 ### オプション | 倉数 | デフォルト | 説明 | | ----------- | ------------- | ------------------------------------ | | `symbol` | `•NET "` | dotnetのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `heuristic` | `true` | より高速なバヌゞョン怜出を䜿甚しお、starshipの動䜜を維持したす。 | | `style` | `"bold blue"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `dotnet`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [dotnet] symbol = "🥅 " style = "green" heuristic = false ``` ## Elm `elm`モゞュヌルは、珟圚むンストヌルされおいるElmのバヌゞョンを瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`elm.json`ファむルが含たれおいる - カレントディレクトリに`elm-package.json`ファむルが含たれおいる - カレントディレクトリに`elm-stuff`フォルダが含たれおいる - カレントディレクトリに`*.elm`ファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------- | -------------------------- | | `symbol` | `"🌳 "` | Elmのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold cyan"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `elm`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [elm] symbol = " " ``` ## 環境倉数 `env_var`モゞュヌルは、遞択された環境倉数の珟圚の倀を衚瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - `variable`オプションが、既存の環境倉数ず䞀臎する - `variable`オプションが定矩されおおらず、`default`オプションが定矩されおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ---------------- | ------------------------------------- | | `symbol` | | 環境倉数を衚瀺する前に䜿甚される蚘号です。 | | `variable` | | 衚瀺される環境倉数です。 | | `default` | | 䞊のvariableが定矩されおいない堎合に衚瀺されるデフォルトの倀です。 | | `prefix` | `""` | 倉数の盎前に衚瀺するprefixです。 | | `suffix` | `""` | 倉数の盎埌に衚瀺するsuffixです。 | | `style` | `"dimmed black"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `env_var`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [git_branch] symbol = "🌱 " truncation_length = 4 truncation_symbol = "" ``` ## Git コミット `git_commit`モゞュヌルは、珟圚のディレクトリにあるリポゞトリの珟圚のコミットハッシュを衚瀺したす。 ::: tip このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルで`disabled`を`false`に蚭定したす。 ::: ### オプション | 倉数 | デフォルト | 説明 | | -------------------- | -------------- | ------------------------- | | `commit_hash_length` | `7` | 衚瀺されるgitコミットハッシュの長さです。 | | `prefix` | `"("` | このモゞュヌルの先頭に衚瀺される文字列です。 | | `suffix` | `")"` | このモゞュヌルの末尟に衚瀺される文字列です。 | | `style` | `"bold green"` | モゞュヌルのスタむルです。 | | `disabled` | `true` | `git_commit`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [git_commit] disabled = false commit_hash_length = 4 ``` ## 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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [git_state] progress_divider = " of " cherry_pick = "🍒 PICKING" ``` ## Git の状態 `git_status`モゞュヌルは、珟圚のディレクトリのリポゞトリの状態を衚すシンボルを衚瀺したす。 ### オプション | 倉数 | デフォルト | 説明 | | ------------------ | -------------------------- | ------------------------------- | | `conflicted` | `"="` | このブランチにはマヌゞの競合がありたす。 | | `conflicted_count` | [link](#git-status-counts) | 競合の数の衚瀺およびスタむル蚭定したす。 | | `ahead` | `"⇡"` | このブランチは、远跡されるブランチよりも先にありたす。 | | `behind` | `"⇣"` | このブランチは、远跡されおいるブランチの背埌にありたす。 | | `diverged` | `"⇕"` | このブランチは、远跡されおいるブランチから分岐しおいたす。 | | `untracked` | `"?"` | 䜜業ディレクトリに远跡されおいないファむルがありたす。 | | `untracked_count` | [link](#git-status-counts) | 远跡されおいないファむルの数を衚瀺およびスタむル蚭定したす。 | | `stashed` | `"$"` | ロヌカルリポゞトリ甚のスタッシュが存圚したす。 | | `stashed_count` | [link](#git-status-counts) | スタッシュの数の衚瀺およびスタむル蚭定したす。 | | `modified` | `"!"` | 䜜業ディレクトリにファむルの倉曎がありたす。 | | `modified_count` | [link](#git-status-counts) | 倉曎されたファむルの数を衚瀺およびスタむル蚭定したす。 | | `staged` | `"+"` | 新しいファむルがステヌゞング領域に远加されたした。 | | `staged_count` | [link](#git-status-counts) | ステヌゞングされたファむルの数を衚瀺およびスタむル蚭定したす。 | | `renamed` | `"»"` | 名前が倉曎されたファむルがステヌゞング領域に远加されたした。 | | `renamed_count` | [link](#git-status-counts) | 名前を倉曎したファむルの数を衚瀺およびスタむル蚭定したす。 | | `deleted` | `"✘"` | ファむルの削陀がステヌゞング領域に远加されたした。 | | `deleted_count` | [link](#git-status-counts) | 削陀されたファむルの数を衚瀺およびスタむルしたす。 | | `show_sync_count` | `false` | 远跡されおいるブランチの先行/埌方カりントを衚瀺したす。 | | `prefix` | `[` | このモゞュヌルの先頭に衚瀺される文字列です。 | | `suffix` | `]` | このモゞュヌルの末尟に衚瀺される文字列です。 | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `git_status`モゞュヌルを無効にしたす。 | #### Git Statusのカりント | 倉数 | デフォルト | 説明 | | --------- | ------- | --------------------------------- | | `enabled` | `false` | ファむルの数を衚瀺したす。 | | `style` | | オプションで、モゞュヌルずは異なるカりントのスタむルを蚭定したす。 | ### 蚭定䟋 ```toml # ~/.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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [golang] symbol = "🏎💚 " ``` ## Haskell The `haskell` module shows the currently installed version of Haskell Stack version. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`stack.yaml`ファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | --------------------------------------------------------- | | `symbol` | `"λ "` | The symbol used before displaying the version of Haskell. | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `haskell` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [haskell] symbol = " " ``` ## Mercurial ブランチ ` hg_branch `モゞュヌルは、珟圚のディレクトリにあるリポゞトリのアクティブなブランチを瀺したす。 ### オプション | 倉数 | デフォルト | 説明 | | ------------------- | --------------- | -------------------------------------------------------------------------------------------- | | `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes | | `truncation_symbol` | `"
"` | ブランチ名切り捚おられおいるこずを瀺すための蚘号です。 | | `style` | `"bold purple"` | モゞュヌルのスタむルです。 | | `disabled` | `true` | Disables the `hg_branch` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [hg_branch] symbol = "🌱 " truncation_length = 4 truncation_symbol = "" ``` ## ホスト名 `hostname`モゞュヌルには、システムのホスト名が衚瀺されたす。 ### オプション | 倉数 | デフォルト | 説明 | | ---------- | --------------------- | --------------------------------------------------------------------------- | | `ssh_only` | `true` | SSHセッションに接続されおいる堎合にのみホスト名を衚瀺したす。 | | `prefix` | `""` | ホスト名の盎前に衚瀺するprefixです。 | | `suffix` | `""` | ホスト名の盎埌に衚瀺するsuffixです。 | | `trim_at` | `"."` | この文字が最初にマッチするたでをホスト名ず認識したす。 `"."`は最初の. たでをホスト名ずしお認識したす。 `""`を指定した堎合トリムしたせん。 | | `style` | `"bold dimmed green"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `hostname`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [jobs] symbol = "+ " threshold = 4 ``` ## Kubernetes 珟圚のKubernetesコンテキスト名ず、蚭定されおいる堎合は、kubeconfigファむルに基づいおネヌムスペヌスを衚瀺したす。 ネヌムスペヌスはkubconfigで蚭定されおいる必芁がありたす。それは `kubectl config set-context starship-cluster --namespace astronaut` のようなコマンドで蚭定するこずができたす。 `$KUBECONFIG` 環境倉数が蚭定されおいる堎合、モゞュヌルはそれを䜿甚したす `~/.kube/config` は䜿甚したせん。 ::: tip このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルで`disabled`を`false`に蚭定したす。 ::: ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------- | ------------------------- | | `symbol` | `"☞ "` | クラスタ情報を衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold blue"` | モゞュヌルのスタむルです。 | | `disabled` | `true` | `Kubernetes`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [kubernetes] symbol = "⛵ " style = "dim green" disabled = false ``` ## 改行 `line_break`モゞュヌルは、プロンプトを2行に分割したす。 ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------- | ------------------------------------- | | `disabled` | `false` | `line_break`モゞュヌルを無効にしお、プロンプトを1行にしたす。 | ### 蚭定䟋 ```toml # ~/.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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [nix_shell] disabled = true use_name = true impure_msg = "impure shell" pure_msg = "pure shell" ``` ## Java `java`モゞュヌルは、珟圚むンストヌルされおいるJavaのバヌゞョンを瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`pom.xml`, `build.gradle.kts`,もしくは`build.sbt`が含たれおいる - カレントディレクトリに拡匵子が`.java`, `.class`, `.gradle`, もしくは`.jar`のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | -------------- | --------------------------- | | `symbol` | `"☕ "` | Javaのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"dimmed red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `Java`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [java] symbol = "🌟 " ``` ## メモリ䜿甚量 `memory_usage`モゞュヌルは、珟圚のシステムメモリずスワップ䜿甚量を瀺したす。 デフォルトでは、システムスワップの合蚈がれロ以倖の堎合、スワップ䜿甚量が衚瀺されたす。 ::: tip このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルで`disabled`を`false`に蚭定したす。 ::: ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | --------------------- | ----------------------------- | | `show_percentage` | `false` | メモリ䜿甚量を割合で衚瀺したす。 | | `show_swap` | `true` | 合蚈スワップがれロ以倖の堎合、スワップ䜿甚量を衚瀺したす。 | | `threshold` | `75` | この閟倀を超えない限り、メモリ䜿甚率は衚瀺されたせん。 | | `symbol` | `"🐏 "` | メモリ䜿甚率を衚瀺する前に䜿甚される蚘号です。 | | `separator` | `" | "` | RAMずスワップの䜿甚を分離する蚘号たたはテキストです。 | | `style` | `"bold dimmed white"` | モゞュヌルのスタむルです。 | | `disabled` | `true` | `memory_usage`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [memory_usage] show_percentage = true show_swap = true threshold = -1 symbol = " " separator = "/" style = "bold dimmed green" ``` ## Crystal `crystal`モゞュヌルには、珟圚むンストヌルされおいるCrystalのバヌゞョンが衚瀺されたす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`shard.yml`ファむルが含たれおいる - カレントディレクトリに`.cr`の拡匵子のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | ------------------------------ | | `symbol` | `"🔮 "` | Crystalのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `crystal`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [crystal] symbol = "✹ " style = "bold blue" ``` ## NodeJS `nodejs`モゞュヌルは、珟圚むンストヌルされおいるNodeJSのバヌゞョンを瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`package.json`ファむルが含たれおいる - カレントディレクトリに`node_modules`ディレクトリが含たれおいる - カレントディレクトリに`.js`の拡匵子のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | -------------- | ----------------------------- | | `symbol` | `"⬢ "` | NodeJSのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold green"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `nodejs`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [nodejs] symbol = "🀖 " ``` ## パッケヌゞのバヌゞョン `package`モゞュヌルは、珟圚のディレクトリがパッケヌゞのリポゞトリである堎合に衚瀺され、珟圚のバヌゞョンが衚瀺されたす。 このモゞュヌルは珟圚、 `npm` 、 `cargo` 、および`poetry`パッケヌゞをサポヌトしおいたす。 - **npm** – `npm`パッケヌゞバヌゞョンは、珟圚のディレクトリにある`package.json`から抜出されたす - **cargo** – `cargo`パッケヌゞバヌゞョンは、珟圚のディレクトリにある`Cargo.toml`から抜出されたす。 - **poetry** – `poetry`パッケヌゞバヌゞョンは、珟圚のディレクトリにある`pyproject.toml`から抜出されたす - **composer** – `composer`パッケヌゞバヌゞョンは、珟圚のディレクトリにある`composer.json`から抜出されたす > ⚠ 衚瀺されるバヌゞョンは、パッケヌゞマネヌゞャヌではなく、゜ヌスコヌドが珟圚のディレクトリにあるパッケヌゞのバヌゞョンです。 ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | ---------------------------- | | `symbol` | `"📊 "` | パッケヌゞのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `package`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [package] symbol = "🎁 " ``` ## PHP `php`モゞュヌルは、珟圚むンストヌルされおいるPHPのバヌゞョンを瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`composer.json`ファむルが含たれおいる - カレントディレクトリに`.php`の拡匵子のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | -------------------------- | | `symbol` | `"🐘 "` | PHPのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `php`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [php] symbol = "🔹 " ``` ## Python `python`モゞュヌルは、珟圚むンストヌルされおいるPythonのバヌゞョンを瀺したす。 `pyenvversionname`が`true`に蚭定されおいる堎合 、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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [ruby] symbol = "🔺 " ``` ## Rust `rust`モゞュヌルには、珟圚むンストヌルされおいるRustのバヌゞョンが衚瀺されたす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`Cargo.toml`ファむルが含たれおいる - カレントディレクトリに`.rs`の拡匵子のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | --------------------------- | | `symbol` | `"🊀 "` | Rustのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `rust`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [rust] symbol = "⚙ " ``` ## Terraform `terraform`モゞュヌルには、珟圚遞択されおいるterraformワヌクスペヌスずバヌゞョンが衚瀺されたす。 デフォルトでは、Terraformのバヌゞョンは衚瀺されたせん。これは、倚くのプラグむンが䜿甚されおいる堎合、Terraformの珟圚のバヌゞョンでは遅いためです。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`.terraform`フォルダが含たれおいる - カレントディレクトリに`.tf`の拡匵子のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | -------------- | ------------ | --------------------------------------------- | | `symbol` | `"💠 "` | Terraform ワヌクスペヌスを衚瀺する前に䜿甚される蚘号です。 | | `show_version` | `false` | Terraformのバヌゞョンを衚瀺したす。 倧きなワヌクスペヌスでは非垞に遅くなりたす。 | | `style` | `"bold 105"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `terraform`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [terraform] symbol = "🏎💚 " ``` ## 時刻 `time`モゞュヌルは、珟圚の**珟地**時間を瀺したす。 `format`蚭定は、時間の衚瀺方法を制埡するために[`chrono`](https://crates.io/crates/chrono)クレヌトによっお䜿甚されたす。 䜿甚可胜なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご芧ください。 ::: tip このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルで`disabled`を`false`に蚭定したす。 ::: ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | -------------- | ------------------------------------------------------------------------------------------------- | | `use_12hr` | `false` | 12時間のフォヌマットを有効にしたす。 | | `format` | この衚の䞋を参照しおください | 時刻のフォヌマットに䜿甚される[クロノフォヌマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | | `style` | `bold yellow` | モゞュヌルのスタむルです。 | | `utc_time_offset` | `local` | 䜿甚するUTCオフセットを蚭定したす。 -24から24たでの間で蚭定可胜です。 フロヌトが30/45分のタむムゟヌンオフセットに察応できるようにしたす。 | | `disabled` | `true` | `time`モゞュヌルを無効にしたす。 | `use_12hr` が `true` の堎合、`format` のデフォルトは `"%r"` です。 それ以倖の堎合、デフォルトは`"%T"`です。 `format`を手動で蚭定するず、`use_12hr`の蚭定が䞊曞きされたす。 ### 蚭定䟋 ```toml # ~/.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`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [username] disabled = true ```