# 蚭定 ::: 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 ``` PowerShell (Windows) で同様に `$PROFILE`にこの行を远加したす。 ```ps1 $ENV:STARSHIP_CONFIG = "$HOME\.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", "docker_context", "package", "dotnet", "elixir", "elm", "erlang", "golang", "haskell", "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](https://github.com/99designs/aws-vault)を䜿甚する堎合、プロファむル は`AWS_VAULT`env varから読み取られたす。 ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | --------------- | -------------------------------------------------------- | | `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` | 実行時間を衚瀺する最短期間ミリ秒単䜍です。 | | `show_milliseconds` | `false` | 実行時間の秒に加えおミリ秒を衚瀺したす。 | | `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` | 環境が`conda create -p [path]`で䜜成された堎合、環境パスが切り捚おられるディレクトリ数。 `0`は切り捚おがないこずを意味したす。 [`directory`](#directory)もご芧ください。 | | `symbol` | `"C "` | 環境名の盎前に䜿甚されるシンボルです。 | | `style` | `"bold green"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `conda`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [conda] style = "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" ``` ## ディレクトリ `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`モゞュヌルを無効にしたす。 |
このモゞュヌルは、どのようにディレクトリを衚瀺するかに぀いおの高床なオプションをいく぀か持っおいたす。 | 倉数 | デフォルト | 説明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | `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. ```toml [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`.
### 蚭定䟋 ```toml # ~/.config/starship.toml [directory] truncation_length = 8 ``` ## Docker Context `docker_context`モゞュヌルは、 [Dockerコンテキスト](https://docs.docker.com/engine/context/working-with-contexts/)が`デフォルト`に蚭定されおいない堎合、珟圚アクティブな <1>Dockerコンテキストを衚瀺したす。 ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | ------------- | --------------------------------------------------------------------------------------- | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context . | | `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. | | `style` | `"bold blue"` | モゞュヌルのスタむルです。 | | `disabled` | `true` | `docker_context`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [docker_context] symbol = "🐋 " ``` ## 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 ``` ## Elixir The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`mix.exs`ファむルが含たれおいる. ### オプション | 倉数 | デフォルト | 説明 | | ---------- | --------------- | --------------------------------------------------------------- | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `style` | `"bold purple"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `elixir` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [elixir] symbol = "🔮 " ``` ## Elm `elm`モゞュヌルは、珟圚むンストヌルされおいるElmのバヌゞョンを瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`elm.json`ファむルが含たれおいる - カレントディレクトリに`elm-package.json`ファむルが含たれおいる - カレントディレクトリに`.elm-version`ファむルが含たれおいる - カレントディレクトリに`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 bold black"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `env_var`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [env_var] variable = "SHELL" default = "unknown shell" ``` ## Erlang The `erlang` module shows the currently installed version of Erlang/OTP. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`rebar.config`ファむルが含たれおいる. - カレントディレクトリに`erlang.mk`ファむルが含たれおいる. ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ---------- | -------------------------------------------------------- | | `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. | | `style` | `bold red` | The style for this module. | | `disabled` | `false` | Disables the `erlang` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [erlang] symbol = "e " ``` ## 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`モゞュヌルは、珟圚のディレクトリにあるリポゞトリの珟圚のコミットハッシュを衚瀺したす。 ### オプション | 倉数 | デフォルト | 説明 | | -------------------- | -------------- | -------------------------------------- | | `commit_hash_length` | `7` | 衚瀺されるgitコミットハッシュの長さです。 | | `prefix` | `"("` | このモゞュヌルの先頭に衚瀺される文字列です。 | | `suffix` | `")"` | このモゞュヌルの末尟に衚瀺される文字列です。 | | `style` | `"bold green"` | モゞュヌルのスタむルです。 | | `only_detached` | `true` | 切り離されたHEAD状態のずきのみgit commit hashを衚瀺したす | | `disabled` | `false` | `git_commit`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [git_commit] truncation_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`ファむルが含たれおいる - カレントディレクトリに`.go-version`ファむルが含たれおいる - カレントディレクトリに`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 = " " ``` ## ホスト名 `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 ``` ## Java `java`モゞュヌルは、珟圚むンストヌルされおいるJavaのバヌゞョンを瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに `pom.xml`, `build.gradle.kts`, `build.sbt` ,もしくは`.java-version`が含たれおいる - カレントディレクトリに拡匵子が`.java`, `.class`, `.gradle`, もしくは`.jar`のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | -------------- | --------------------------- | | `symbol` | `"☕ "` | Javaのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"dimmed red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `java`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [java] symbol = "🌟 " ``` ## ゞョブ `jobs`モゞュヌルには、実行䞭のゞョブの珟圚の数が衚瀺されたす。 このモゞュヌルは、実行䞭のバックグラりンドゞョブがある堎合にのみ衚瀺されたす。 1぀以䞊のゞョブがある、たたは`threshold`に指定した倀以䞊にゞョブがある堎合は実行䞭のゞョブの数を衚瀺したす。 ### オプション | 倉数 | デフォルト | 説明 | | ----------- | ------------- | ---------------------- | | `symbol` | `"✩"` | ゞョブの数を衚瀺する前に䜿甚される蚘号です。 | | `threshold` | `1` | 超過した堎合、ゞョブの数を衚瀺したす。 | | `style` | `"bold blue"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `jobs`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [jobs] symbol = "+ " threshold = 4 ``` ## Julia `julia`モゞュヌルは、珟圚むンストヌルされおいるJuliaのバヌゞョンを瀺したす。 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - カレントディレクトリに`Project.toml`ファむルが含たれおいる - カレントディレクトリに`Manifest.toml`ファむルが含たれおいる - カレントディレクトリに`.jl`の拡匵子のファむルが含たれおいる ### オプション | 倉数 | デフォルト | 説明 | | ---------- | --------------- | ---------------------------- | | `symbol` | `"ஃ "` | Juliaのバヌゞョンを衚瀺する前に䜿甚される蚘号です。 | | `style` | `"bold purple"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | `julia`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [julia] symbol = "∎ " ``` ## Kubernetes 珟圚のKubernetesコンテキスト名ず、蚭定されおいる堎合は、kubeconfigファむルに基づいおネヌムスペヌスを衚瀺したす。 ネヌムスペヌスはkubconfigで蚭定されおいる必芁がありたす。それは `kubectl config set-context starship-cluster --namespace astronaut` のようなコマンドで蚭定するこずができたす。 `$KUBECONFIG` 環境倉数が蚭定されおいる堎合、モゞュヌルはそれを䜿甚したす `~/.kube/config` は䜿甚したせん。 ::: tip このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルで`disabled`を`false`に蚭定したす。 ::: ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | ------------- | ----------------------------------- | | `symbol` | `"☞ "` | クラスタ情報を衚瀺する前に䜿甚される蚘号です。 | | `context_aliases` | | Table of context aliases to display | | `style` | `"bold blue"` | モゞュヌルのスタむルです。 | | `disabled` | `true` | `Kubernetes`モゞュヌルを無効にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [kubernetes] symbol = "⛵ " style = "dimmed green" disabled = false [kubernetes.context_aliases] "dev.local.cluster.k8s" = "dev" ``` ## 改行 The `line_break` module separates the prompt into two lines. ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------- | ------------------------------------- | | `disabled` | `false` | `line_break`モゞュヌルを無効にしお、プロンプトを1行にしたす。 | ### 蚭定䟋 ```toml # ~/.config/starship.toml [line_break] disabled = true ``` ## メモリ䜿甚量 The `memory_usage` module shows current system memory and swap usage. By default the swap usage is displayed if the total system swap is non-zero. ::: 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] disabled = false show_percentage = true show_swap = true threshold = -1 symbol = " " separator = "/" style = "bold dimmed green" ``` ## Mercurial ブランチ The `hg_branch` module shows the active branch of the repo in your current directory. ### オプション | 倉数 | デフォルト | 説明 | | ------------------- | --------------- | -------------------------------------------------------------------------------------------- | | `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 = "" ``` ## Nim The `nim` module shows the currently installed version of Nim. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension ### オプション | 倉数 | デフォルト | 説明 | | ---------- | --------------- | ----------------------------------------------------- | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `style` | `"bold yellow"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `nim` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [nim] style = "yellow" symbol = "🎣 " ``` ## Nix-shell The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### オプション | 倉数 | デフォルト | 説明 | | ------------ | ------------- | ------------------------------------------------- | | `use_name` | `false` | Display the name of the nix-shell. | | `impure_msg` | `"impure"` | Customize the "impure" msg. | | `pure_msg` | `"pure"` | Customize the "pure" msg. | | `symbol` | `"❄ "` | The symbol used before displaying the shell name. | | `style` | `"bold blue"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `nix_shell` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [nix_shell] disabled = true use_name = true impure_msg = "impure shell" pure_msg = "pure shell" symbol = "☃ " ``` ## NodeJS The `nodejs` module shows the currently installed version of NodeJS. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `node_modules` directory - The current directory contains a file with the `.js` extension ### オプション | 倉数 | デフォルト | 説明 | | ---------- | -------------- | -------------------------------------------------------- | | `symbol` | `"⬢ "` | The symbol used before displaying the version of NodeJS. | | `style` | `"bold green"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `nodejs` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [nodejs] symbol = "🀖 " ``` ## Package Version The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia` and `mix` packages. - **npm** – The `npm` package version is extracted from the `package.json` present in the current directory - **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory - **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory - **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 > ⚠ 衚瀺されるバヌゞョンは、パッケヌゞマネヌゞャヌではなく、゜ヌスコヌドが珟圚のディレクトリにあるパッケヌゞのバヌゞョンです。 ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | ------------ | ---------------------------------------------------------- | | `symbol` | `"📊 "` | The symbol used before displaying the version the package. | | `style` | `"bold 208"` | モゞュヌルのスタむルです。 | | `display_private` | `false` | Enable displaying version for packages marked as private. | | `disabled` | `false` | Disables the `package` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [package] symbol = "🎁 " ``` ## 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 ### オプション | 倉数 | デフォルト | 説明 | | ---------- | --------------- | ------------------------------------------------------- | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `style` | `"bold yellow"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `ocaml` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [ocaml] symbol = "🐪 " ``` ## PHP The `php` module shows the currently installed version of PHP. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` file ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | ----------------------------------------------------- | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `style` | `"bold 147"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `php` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [php] symbol = "🔹 " ``` ## 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`. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `.python-version` file - The current directory contains a `requirements.txt` file - The current directory contains a `pyproject.toml` file - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) - The current directory contains a `Pipfile` file - The current directory contains a `tox.ini` file - The current directory contains a `setup.py` file - The current directory contains a `__init__.py` file - A virtual environment is currently activated ### オプション | 倉数 | デフォルト | 説明 | | -------------------- | --------------- | --------------------------------------------------------------------------- | | `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. | | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) | | `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `style` | `"bold yellow"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `python` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [python] symbol = "👟 " pyenv_version_name = true pyenv_prefix = "foo " ``` ## Ruby The `ruby` module shows the currently installed version of Ruby. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file - The current directory contains a `.rb` file ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | ------------------------------------------------------ | | `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `ruby` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [ruby] symbol = "🔺 " ``` ## Rust The `rust` module shows the currently installed version of Rust. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension ### オプション | 倉数 | デフォルト | 説明 | | ---------- | ------------ | ------------------------------------------------------ | | `symbol` | `"🊀 "` | The symbol used before displaying the version of Rust. | | `style` | `"bold red"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `rust` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [rust] symbol = "⚙ " ``` ## Singularity The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. ### オプション | 倉数 | デフォルト | 説明 | | ---------- | -------------------- | ------------------------------------------------ | | `label` | `""` | Prefix before the image name display. | | `prefix` | `"["` | Prefix to display immediately before image name. | | `suffix` | `"]"` | Suffix to display immediately after image name. | | `symbol` | `""` | The symbol used before the image name. | | `style` | `"bold dimmed blue"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `singularity` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [singularity] symbol = "📊 " ``` ## Terraform The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` extension ### オプション | 倉数 | デフォルト | 説明 | | -------------- | ------------ | ----------------------------------------------------------- | | `symbol` | `"💠 "` | The symbol used before displaying the terraform workspace. | | `show_version` | `false` | Shows the terraform version. Very slow on large workspaces. | | `style` | `"bold 105"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `terraform` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [terraform] symbol = "🏎💚 " ``` ## Time The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip このモゞュヌルはデフォルトで無効になっおいたす。 有効にするには、蚭定ファむルで`disabled`を`false`に蚭定したす。 ::: ### オプション | 倉数 | デフォルト | 説明 | | ----------------- | --------------- | ------------------------------------------------------------------------------------------------------------------- | | `use_12hr` | `false` | Enables 12 hour formatting. | | `format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | | `style` | `"bold yellow"` | The style for the module time. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | | `disabled` | `true` | Disables the `time` module. | | `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 `format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `format` will override the `use_12hr` setting. ### 蚭定䟋 ```toml # ~/.config/starship.toml [time] disabled = false format = "🕙[ %T ]" utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` ## Username The `username` module shows active user's username. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current user is root - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true ### オプション | 倉数 | デフォルト | 説明 | | ------------- | --------------- | ------------------------------------- | | `style_root` | `"bold red"` | The style used when the user is root. | | `style_user` | `"bold yellow"` | The style used for non-root users. | | `show_always` | `false` | Always shows the `username` module. | | `disabled` | `false` | Disables the `username` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [username] disabled = true ``` ## Zig The `zig` module shows the currently installed version of Zig. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `.zig` file ### オプション | 倉数 | デフォルト | 説明 | | ---------- | --------------- | ----------------------------------------------------- | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `zig` module. | ### 蚭定䟋 ```toml # ~/.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. ::: ### オプション | 倉数 | デフォルト | 説明 | | ------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `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` | | [See below](#custom-command-shell) | | `description` | `""` | 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"` | モゞュヌルのスタむルです。 | | `prefix` | `""` | Prefix to display immediately before the command output. | | `suffix` | `""` | Suffix to display immediately after the command output. | | `disabled` | `false` | Disables this `custom` module. | #### 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. ```toml 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](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ::: ### 蚭定䟋 ```toml # ~/.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. 次の条件のいずれかが満たされるず、モゞュヌルが衚瀺されたす。 - The current directory contains a `spago.dhall` file - The current directory contains a \*.purs files ### オプション | 倉数 | デフォルト | 説明 | | ---------- | -------------- | ------------------------------------------------------------ | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `style` | `"bold white"` | モゞュヌルのスタむルです。 | | `disabled` | `false` | Disables the `purescript` module. | ### 蚭定䟋 ```toml # ~/.config/starship.toml [purescript] symbol = "<=> " ```