# 設定 Starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。 ```sh mkdir -p ~/.config && touch ~/.config/starship.toml ``` Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 ```toml # プロンプトの先頭に改行を表示しません add_newline = false # プロンプトの「❯」記号を「➜」に置き換えます [character] # 設定しているモジュールの名前は「character」です success_symbol = "[➜](bold green)" # 「success_symbol」セグメントは「ボールドグリーン」の色で「➜」に設定されています # package モジュールを無効にし、プロンプトから完全に隠します [package] disabled = true ``` `STARSHIP_CONFIG` 環境変数を使用して、デフォルトの`starship.toml` ファイルの場所を変更できます。 ```sh export STARSHIP_CONFIG=~/.starship ``` PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。 ```ps1 $ENV:STARSHIP_CONFIG = "$HOME\.starship" ``` ### Logging By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: ```sh export STARSHIP_CACHE=~/.starship/cache ``` PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。 ```ps1 $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ``` ### Terminology **Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. **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` は、`version` という名前の変数を持つフォーマット文字列です。 - `$git_branch$git_commit` は `git_branch` と `git_commit` という2つの変数を持つフォーマット文字列です。 - `$git_branch $git_commit` には空白で区切られた 2 つの変数があります。 #### テキストグループ A text group is made up of two different parts. The first part, which is enclosed in a `[]`, is a [format string](#format-strings). 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](#style-strings). This can be used style the first part. For example: - `[on](red bold)` は文字列 `on` に太字のテキストを赤色で表示します。 - `[⬢ $version](bold green)` はシンボル `⬢` の後に変数 `バージョン`の内容を表示します 緑色の太字を付けています - `[a [b](red) c](green)` は `a b c` を `b` だけ赤色に表示し、 `a` と `c` を緑色に表示します。 #### スタイルの設定 Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/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"`は、紫色の太字斜体のテキストを設定します - `""` はすべてのスタイルを明示的に無効にします Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics. #### 条件付きフォーマット設定 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\] )`. #### エスケープ可能な文字 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](https://github.com/toml-lang/toml#user-content-string). 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: ```toml # with basic string format = "\n\\$" # with multiline basic string format = """ \\$""" # with literal string format = ''' \$''' ``` ## プロンプト This is the list of prompt-wide configuration options. ### オプション | オプション | デフォルト | 説明 | | -------------- | ------------------------------ | ---------------------------------------- | | `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 | | `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 | | `add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 | ### 設定例 ```toml # ~/.config/starship.toml # 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 # Disable the newline at the start of the prompt add_newline = false ``` ### Default Prompt Format The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown: ```toml format = "$all" # Which is equivalent to format = """ $username\ $hostname\ $shlvl\ $kubernetes\ $directory\ $git_branch\ $git_commit\ $git_state\ $git_status\ $hg_branch\ $docker_context\ $package\ $cmake\ $dart\ $dotnet\ $elixir\ $elm\ $erlang\ $golang\ $helm\ $java\ $julia\ $nim\ $nodejs\ $ocaml\ $perl\ $php\ $purescript\ $python\ $ruby\ $rust\ $swift\ $terraform\ $zig\ $nix_shell\ $conda\ $memory_usage\ $aws\ $gcloud\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ $jobs\ $battery\ $time\ $status\ $character""" ``` ## AWS The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var. ### オプション | オプション | デフォルト | 説明 | | ---------------- | ---------------------------------------------------- | ----------------------------- | | `format` | `"on [$symbol$profile(\\($region\\))]($style) "` | moduleのフォーマットです。 | | `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | | `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 | | `disabled` | `false` | `aws`モジュールを無効にします。 | ### Variables | 変数 | 設定例 | 説明 | | --------- | ---------------- | ---------------------- | | region | `ap-northeast-1` | 現在のAWSリージョン | | profile | `astronauts` | 現在のAWSプロファイル | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### Examples #### すべてを表示 ```toml # ~/.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" ``` #### リージョンを表示 ```toml # ~/.config/starship.toml [aws] format = "on [$symbol$region]($style) " style = "bold blue" symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" ``` #### プロファイルを表示 ```toml # ~/.config/starship.toml [aws] format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " ``` ## バッテリー The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. ### オプション | オプション | デフォルト | 説明 | | -------------------- | --------------------------------- | ------------------------- | | `full_symbol` | `"•"` | バッテリーが満タンのときに表示される記号です。 | | `charging_symbol` | `"⇡"` | バッテリーの充電中に表示される記号です。 | | `discharging_symbol` | `"⇣"` | バッテリーが放電しているときに表示される記号です。 | | `format` | `"[$symbol$percentage]($style) "` | moduleのフォーマットです。 | | `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 | | `disabled` | `false` | `battery`モジュールを無効にします。 |
There are also options for some uncommon battery states. | 変数 | 説明 | | ---------------- | ------------------------ | | `unknown_symbol` | バッテリー状態が不明なときに表示される記号です。 | | `empty_symbol` | バッテリーが空のときに表示される記号です。 | Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
### 設定例 ```toml # ~/.config/starship.toml [battery] full_symbol = "🔋" charging_symbol = "⚡️" discharging_symbol = "💀" ``` ### Battery Display The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown: ```toml [[battery.display]] threshold = 10 style = "bold red" ``` #### オプション The `display` option is an array of the following table. | 変数 | 説明 | | ----------- | ------------------------------ | | `threshold` | バッテリーが表示される上限です。 | | `style` | displayオプションが使用されている場合のスタイルです。 | #### 設定例 ```toml [[battery.display]] # "bold red" style when capacity is between 0% and 10% threshold = 10 style = "bold red" [[battery.display]] # "bold yellow" style when capacity is between 10% and 30% threshold = 30 style = "bold yellow" # when capacity is over 30%, the battery indicator will not be displayed ``` ## 文字 The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. The character will tell you whether the last command was successful or not. It can do this in two ways: - 色の変更 (`赤`/`緑`) - プロンプトの表示の変更 (`❯`/`✖`) By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). ### オプション | オプション | デフォルト | 説明 | | ---------------- | ------------------- | -------------------------------------------------------------------------------- | | `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 ```toml # ~/.config/starship.toml [character] success_symbol = "[➜](bold green) " error_symbol = "[✗](bold red) " ``` #### Without custom error shape ```toml # ~/.config/starship.toml [character] success_symbol = "[➜](bold green) " error_symbol = "[➜](bold red) " ``` #### With custom vim shape ```toml # ~/.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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | 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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ## コマンド実行時間 The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. ::: warning Do not hook the DEBUG trap in Bash If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### オプション | オプション | デフォルト | 説明 | | ------------------- | ----------------------------- | --------------------------- | | `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 | | `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | | `format` | `"took [$duration]($style) "` | moduleのフォーマットです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 | | `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | | duration | `16m40s` | コマンドの実行時間 | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [cmd_duration] min_time = 500 format = "underwent [$duration](bold yellow)" ``` ## Conda The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### オプション | オプション | デフォルト | 説明 | | ------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | `truncation_length` | `1` | 環境が`conda create -p [path]`で作成された場合、環境パスが切り捨てられるディレクトリ数。 `0`は切り捨てがないことを意味します。 [`directory`](#directory)もご覧ください。 | | `symbol` | `"🅒 "` | 環境名の直前に使用されるシンボルです。 | | `style` | `"bold green"` | モジュールのスタイルです。 | | `format` | `"[$symbol$environment]($style) "` | moduleのフォーマットです。 | | `ignore_base` | `true` | Ignores `base` environment when activated. | | `disabled` | `false` | Disables the `conda` module. | ### Variables | 変数 | 設定例 | 説明 | | ----------- | ------------ | ----------------------------- | | environment | `astronauts` | The current conda environment | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [conda] format = "[$symbol$environment](dimmed green) " ``` ## Crystal The `crystal` module shows the currently installed version of Crystal. 次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`shard.yml`ファイルが含まれている - カレントディレクトリに`.cr`の拡張子のファイルが含まれている ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ------------------------------ | | `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 | | `style` | `"bold red"` | モジュールのスタイルです。 | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `disabled` | `false` | `crystal`モジュールを無効にします。 | ### Variables | 変数 | 設定例 | 説明 | | --------- | --------- | ------------------------ | | version | `v0.32.1` | The version of `crystal` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [crystal] format = "via [✨ $version](bold blue) " ``` ## Dart The `dart` module shows the currently installed version of Dart. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory - The current directory contains a `pubspec.yaml` or `pubspec.lock` file ### オプション | 変数 | デフォルト | 説明 | | ---------- | ---------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `dart` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | | version | `v2.8.4` | The version of `dart` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [dart] format = "via [🔰 $version](bold red) " ``` ## Directory The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### オプション | 変数 | デフォルト | 説明 | | ------------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------- | | `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | | `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | | `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | moduleのフォーマットです。 | | `style` | `"bold cyan"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `directory` module. | | `read_only_symbol` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only_symbol_style` | `"red"` | The style for the read only symbol. |
This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | デフォルト | 説明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------- | | `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`.
### Variables | 変数 | 設定例 | 説明 | | --------- | --------------------- | -------------------------- | | path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [directory] truncation_length = 8 ``` ## Docker Context The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. ### オプション | オプション | デフォルト | 説明 | | ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol$context]($style) "` | 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` | Disables the `docker_context` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------------- | -------------------------- | | context | `test_context` | The current docker context | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [docker_context] format = "via [🐋 $context](blue bold)" ``` ## Dotnet The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. This module will only be shown in your prompt when one 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. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### オプション | オプション | デフォルト | 説明 | | ----------- | ---------------------------------------- | -------------------------------------------------------- | | `format` | `"v[$symbol$version( 🎯 $tfm)]($style) "` | moduleのフォーマットです。 | | `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `dotnet` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ---------------- | ------------------------------------------------------------------ | | version | `v3.1.201` | The version of `dotnet` sdk | | tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [dotnet] symbol = "🥅 " style = "green" heuristic = false ``` ## Elixir The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `mix.exs` file. ### オプション | オプション | デフォルト | 説明 | | ---------- | ------------------------------------------------------------- | --------------------------------------------------------------- | | `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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [elixir] symbol = "🔮 " ``` ## Elm The `elm` module shows the currently installed version of Elm. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `elm.json` file - The current directory contains a `elm-package.json` file - The current directory contains a `.elm-version` file - The current directory contains a `elm-stuff` folder - The current directory contains a `*.elm` files ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `style` | `"cyan bold"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `elm` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --------- | ---------------------- | | version | `v0.19.1` | The version of `elm` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [elm] format = "via [ $version](cyan bold) " ``` ## Environment Variable The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is ### オプション | オプション | デフォルト | 説明 | | ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | `symbol` | | The symbol used before displaying the variable value. | | `variable` | | The environment variable to be displayed. | | `default` | | The default value to be displayed when the selected variable is not defined. | | `format` | `"with [$env_value]($style) "` | moduleのフォーマットです。 | | `disabled` | `false` | Disables the `env_var` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ------------------------------------------- | ------------------------------------------ | | env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | | symbol | | オプション `記号` の値をミラーする | | style\* | `black bold dimmed` | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [env_var] variable = "SHELL" default = "unknown shell" ``` ## Erlang The `erlang` module shows the currently installed version of Erlang/OTP. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `rebar.config` file. - The current directory contains a `erlang.mk` file. ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | -------------------------------------------------------- | | `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | モジュールのスタイルです。 | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `disabled` | `false` | Disables the `erlang` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --------- | ----------------------- | | version | `v22.1.3` | The version of `erlang` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [erlang] format = "via [e $version](bold red) " ``` ## Gcloud The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. ### オプション | 変数 | デフォルト | 説明 | | ---------------- | ---------------------------------------------------- | --------------------------------------------------------------- | | `format` | `"on [$symbol$account(\\($region\\))]($style) "` | moduleのフォーマットです。 | | `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | | `region_aliases` | | Table of region aliases to display in addition to the GCP name. | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `gcloud` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ----------------- | ------------------------------------------------------------------ | | region | `us-central1` | The current GCP region | | account | `foo@example.com` | The current GCP profile | | project | | The current GCP project | | active | `default` | The active config name written in `~/.config/gcloud/active_config` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### Examples #### Display account and project ```toml # ~/.config/starship.toml [gcloud] format = "on [$symbol$account(\\($project\\))]($style) " ``` #### Display active config name only ```toml # ~/.config/starship.toml [gcloud] format = "[$symbol$active]($style) " style = "bold yellow" ``` #### Display account and aliased region ```toml # ~/.config/starship.toml [gcloud] symbol = "️🇬️ " [gcloud.region_aliases] us-central1 = "uc1" asia-northeast1 = "an1" ``` ## Git Branch The `git_branch` module shows the active branch of the repo in your current directory. ### オプション | オプション | デフォルト | 説明 | | ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | `format` | `"on [$symbol$branch]($style) "` | 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` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------------------------------------------------------------------------------------- | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [git_branch] symbol = "🌱 " truncation_length = 4 truncation_symbol = "" ``` ## Git Commit The `git_commit` module shows the current commit hash of the repo in your current directory. ### オプション | オプション | デフォルト | 説明 | | -------------------- | ------------------------------ | ----------------------------------------------------- | | `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `"[\\($hash\\)]($style) "` | moduleのフォーマットです。 | | `style` | `"bold green"` | モジュールのスタイルです。 | | `only_detached` | `true` | Only show git commit hash when in detached HEAD state | | `disabled` | `false` | Disables the `git_commit` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --------- | --------------------------- | | hash | `b703eb3` | The current git commit hash | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [git_commit] commit_hash_length = 4 ``` ## Git State The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### オプション | オプション | デフォルト | 説明 | | -------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `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)\\) "` | moduleのフォーマットです。 | | `disabled` | `false` | Disables the `git_state` module. | ### Variables | 変数 | 設定例 | 説明 | | ---------------- | ---------- | ------------------------------ | | state | `REBASING` | The current state of the repo | | progress_current | `1` | The current operation progress | | progress_total | `2` | The total operation progress | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [git_state] format = "[\\($state( $progress_current of $progress_total)\\)]($style) " cherry_pick = "[🍒 PICKING](bold red)" ``` ## Git の状態 The `git_status` module shows symbols representing the state of the repo in your current directory. ### オプション | オプション | デフォルト | 説明 | | ------------ | --------------------------------------------- | --------------------------------- | | `format` | `"[\[$all_status$ahead_behind\]]($style) "` | `git_status` のデフォルトフォーマット | | `conflicted` | `"="` | このブランチにはマージの競合があります。 | | `ahead` | `"⇡"` | `ahead`のフォーマット | | `behind` | `"⇣"` | `behind`のフォーマット | | `diverged` | `"⇕"` | `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` | | `style` | `"bold red"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `git_status` module. | ### 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\* | オプション `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` | Show the number of files | ### 設定例 ```toml # ~/.config/starship.toml [git_status] conflicted = "🏳" ahead = "🏎💨" behind = "😰" diverged = "😵" untracked = "🤷‍" stashed = "📦" modified = "📝" staged = '[++\($count\)](green)' renamed = "👅" deleted = "🗑" ``` Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml [git_status] ahead = "⇡${count}" diverged = "⇕⇡${ahead_count}⇣${behind_count}" behind = "⇣${count}" ``` ## Golang The `golang` module shows the currently installed version of Golang. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `go.mod` file - The current directory contains a `go.sum` file - The current directory contains a `glide.yaml` file - The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.lock` file - The current directory contains a `.go-version` file - The current directory contains a `Godeps` directory - The current directory contains a file with the `.go` extension ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ---------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `style` | `"bold cyan"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `golang` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --------- | ---------------------- | | version | `v1.12.1` | The version of `go` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [golang] format = "via [🏎💨 $version](bold cyan) " ``` ## Helm The `helm` module shows the currently installed version of Helm. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `helmfile.yaml` file - The current directory contains a `Chart.yaml` file ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ------------------------------------------------ | | `format` | `"via [$symbol$version]($style) "` | 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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [helm] format = "via [⎈ $version](bold white) " ``` ## Hostname The `hostname` module shows the system hostname. ### オプション | オプション | デフォルト | 説明 | | ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `format` | `"[$hostname]($style) in "` | moduleのフォーマットです。 | | `style` | `"bold dimmed green"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `hostname` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --- | ---------------------- | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [hostname] ssh_only = false format = "on [$hostname](bold red) " trim_at = ".companyname.com" disabled = false ``` ## Java The `java` module shows the currently installed version of Java. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file - The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension ### オプション | オプション | デフォルト | 説明 | | ---------- | -------------------------------------- | ----------------------------------------------- | | `format` | `"via [${symbol}${version}]($style) "` | moduleのフォーマットです。 | | `symbol` | `"☕ "` | A format string representing the symbol of Java | | `style` | `"red dimmed"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `java` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ----- | ---------------------- | | version | `v14` | The version of `java` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [java] symbol = "🌟 " ``` ## Jobs The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. ### オプション | オプション | デフォルト | 説明 | | ----------- | ----------------------------- | ------------------------------------------------ | | `threshold` | `1` | Show number of jobs if exceeded. | | `format` | `"[$symbol$number]($style) "` | moduleのフォーマットです。 | | `symbol` | `"✦"` | A format string representing the number of jobs. | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `jobs` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --- | ---------------------- | | number | `1` | The number of jobs | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [jobs] symbol = "+ " threshold = 4 ``` ## Julia The `julia` module shows the currently installed version of Julia. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Project.toml` file - The current directory contains a `Manifest.toml` file - The current directory contains a file with the `.jl` extension ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `style` | `"bold purple"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `julia` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | | version | `v1.4.0` | The version of `julia` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.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 This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション | オプション | デフォルト | 説明 | | ----------------------- | -------------------------------------------------------- | --------------------------------------------------------------------- | | `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | | `format` | `"[$symbol$context( \\($namespace\\))]($style) in "` | 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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [kubernetes] format = "on [⛵ $context \\($namespace\\)](dimmed green) " disabled = false [kubernetes.context_aliases] "dev.local.cluster.k8s" = "dev" ``` ## Line Break The `line_break` module separates the prompt into two lines. ### オプション | オプション | デフォルト | 説明 | | ---------- | ------- | ------------------------------------------------------------------ | | `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### 設定例 ```toml # ~/.config/starship.toml [line_break] disabled = true ``` ## Memory Usage 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 This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション | オプション | デフォルト | 説明 | | ----------- | --------------------------------------------- | -------------------------------------------------------- | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | | `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | | `style` | `"bold dimmed white"` | モジュールのスタイルです。 | | `disabled` | `true` | Disables the `memory_usage` module. | ### 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 | `🐏` | オプション `記号` の値をミラーする | | style\* | | オプション `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 ### 設定例 ```toml # ~/.config/starship.toml [memory_usage] disabled = false show_percentage = true show_swap = true threshold = -1 symbol = " " separator = "/" style = "bold dimmed green" ``` ## Mercurial Branch 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. | | `style` | `"bold purple"` | モジュールのスタイルです。 | | `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | | `disabled` | `true` | Disables the `hg_branch` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | --------------------------- | | branch | `master` | The active mercurial branch | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.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. 次の条件のいずれかが満たされると、モジュールが表示されます。 - 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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```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. ### オプション | オプション | デフォルト | 説明 | | ------------ | -------------------------------------------------- | ----------------------------------------------------- | | `format` | `"via [$symbol$state( \\($name\\))]($style) "` | 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` | Disables the `nix_shell` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ------- | -------------------------- | | state | `pure` | The state of the nix-shell | | name | `lorri` | The name of the nix-shell | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.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 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`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | -------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `style` | `"bold green"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `nodejs` module. | ###  Variables | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------- | | version | `v13.12.0` | The version of `node` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [nodejs] format = "via [🤖 $version](bold green) " ``` ## 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`, `mix` and `helm` 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 - **helm** - The `helm` chart version is extracted from the `Chart.yaml` present - **maven** - The `maven` package version is extracted from the `pom.xml` present > ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。 ### オプション | オプション | デフォルト | 説明 | | ----------------- | ---------------------------------- | ---------------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `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. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | --------------------------- | | version | `v1.0.0` | The version of your package | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ------------------------------------------------------- | | `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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [ocaml] format = "via [🐪 $version]($style) " ``` ## Perl The `perl` module shows the currently installed version of Perl. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `META.json` file or `META.yml` file - The current directory contains a `.perl-version` file - The current directory contains a `.pl`, `.pm` or `.pod` ### オプション | 変数 | デフォルト | 説明 | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `style` | `"bold 149"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `perl` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --------- | ---------------------- | | version | `v5.26.1` | The version of `perl` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | ### 設定例 ```toml # ~/.config/starship.toml [perl] format = "via [🦪 $version]($style) " ``` ## 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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `style` | `"147 bold"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `php` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | | version | `v7.3.8` | The version of `php` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.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`. 次の条件のいずれかが満たされると、モジュールが表示されます。 - 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 ### オプション | オプション | デフォルト | 説明 | | -------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `format` | `"via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | モジュールのスタイルです。 | | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `disabled` | `false` | Disables the `python` module. | ### Variables | 変数 | 設定例 | 説明 | | ------------ | --------------- | ------------------------------------------ | | version | `"v3.8.1"` | The version of `python` | | symbol | `"🐍 "` | オプション `記号` の値をミラーする | | style | `"yellow bold"` | オプション `style` の値をミラーする | | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | 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. ```toml # ~/.config/starship.toml [python] python_binary = "python3" ```
### 設定例 ```toml # ~/.config/starship.toml [python] symbol = "👾 " pyenv_version_name = true ``` ## 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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ------------------------------------------------ | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `style` | `"bold red"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `ruby` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | | version | `v2.5.1` | The version of `ruby` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `style` | `"bold red"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `rust` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ----------------- | ---------------------- | | version | `v1.43.0-nightly` | The version of `rustc` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [rust] format = "via [⚙️ $version](red bold)" ``` ## SHLVL The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### オプション | 変数 | デフォルト | 説明 | | ----------- | ---------------------------- | --------------------------------------- | | `threshold` | `2` | Display threshold. | | `format` | `"[$symbol$shlvl]($style) "` | moduleのフォーマットです。 | | `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | | `style` | `"bold yellow"` | モジュールのスタイルです。 | | `disabled` | `true` | Disables the `shlvl` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | --- | -------------------------- | | shlvl | `3` | The current value of SHLVL | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [shlvl] disabled = false format = "$shlvl level(s) down" threshold = 3 ``` ## Singularity The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. ### オプション | オプション | デフォルト | 説明 | | ---------- | ------------------------------------ | ------------------------------------------------ | | `format` | `"[$symbol\\[$env\\]]($style) "` | 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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [singularity] format = "[📦 \\[$env\\]]($style) " ``` ## Swift The `swift` module shows the currently installed version of Swift. 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ------------------------------------------------ | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `style` | `"bold 202"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `swift` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | | version | `v5.2.4` | The version of `swift` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [swift] format = "via [🏎 $version](red bold)" ``` ## Status The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション | 変数 | デフォルト | 説明 | | ---------- | -------------------------- | ------------------------------------------------------ | | `format` | `[$symbol$status]($style)` | The format of the module | | `symbol` | `"✖"` | A format string representing the symbol for the status | | `style` | `"bold red"` | モジュールのスタイルです。 | | `disabled` | `true` | Disables the `status` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ----- | --------------------------------- | | status | `127` | The exit code of the last command | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [status] style = "bg:blue" symbol = "💣 " format = "[\\[$symbol$status\\]]($style) " disabled = false ``` ## 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. If you still want to enable it, [follow the example shown below](#with-version). 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` extension ### オプション | オプション | デフォルト | 説明 | | ---------- | ------------------------------------ | ----------------------------------------------------- | | `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` | Disables the `terraform` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | ---------- | ------------------------------- | | version | `v0.12.24` | The version of `terraform` | | workspace | `default` | The current terraform workspace | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 #### With Version ```toml # ~/.config/starship.toml [terraform] format = "[🏎💨 $version$workspace]($style) " ``` #### Without version ```toml # ~/.config/starship.toml [terraform] format = "[🏎💨 $workspace]($style) " ``` ## 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 This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション | オプション | デフォルト | 説明 | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `format` | `"at [$time]($style) "` | The format string for the module. | | `use_12hr` | `false` | Enables 12 hour formatting | | `time_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 `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------- | | time | `13:08:10` | The current time. | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.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 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. | | `format` | `"[$user]($style) in "` | moduleのフォーマットです。 | | `show_always` | `false` | Always shows the `username` module. | | `disabled` | `false` | Disables the `username` module. | ### 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. | ### 設定例 ```toml # ~/.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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | モジュールのスタイルです。 | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `disabled` | `false` | Disables the `zig` module. | ### Variables | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | | version | `v0.6.0` | The version of `zig` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```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 including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: ::: tip [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! ::: ### オプション | オプション | デフォルト | 説明 | | ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `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"` | モジュールのスタイルです。 | | `format` | `"[$symbol$output]($style) "` | moduleのフォーマットです。 | | `disabled` | `false` | Disables this `custom` module. | ### Variables | 変数 | 説明 | | --------- | -------------------------------------- | | output | The output of shell command in `shell` | | symbol | オプション `記号` の値をミラーする | | style\* | オプション `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. The `command` will be passed in on stdin. 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" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" files = ["*.pst"] 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 ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | ------------------------------------------------------------ | | `format` | `"via [$symbol$version]($style) "` | 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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | \*: This variable can only be used as a part of a style string ### 設定例 ```toml # ~/.config/starship.toml [purescript] format = "via [$symbol$version](bold white)" ```