diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index b66bfe9f..f8de8581 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -253,6 +253,7 @@ $kubernetes\ $directory\ $vcsh\ $fossil_branch\ +$fossil_metrics\ $git_branch\ $git_commit\ $git_state\ @@ -1524,35 +1525,70 @@ truncation_length = 4 truncation_symbol = '' ``` +## Fossil Metrics + +The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. + +### オプション + +| オプション | デフォルト | 説明 | +| -------------------- | ------------------------------------------------------------ | ------------------------------------- | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | module のフォーマットです。 | +| `added_style` | `'bold green'` | The style for the added count. | +| `deleted_style` | `'bold red'` | The style for the deleted count. | +| `only_nonzero_diffs` | `true` | Render status only for changed items. | +| `disabled` | `true` | Disables the `fossil_metrics` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| ----------------- | --- | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | +| added_style\* | | Mirrors the value of option `added_style` | +| deleted_style\* | | Mirrors the value of option `deleted_style` | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + +### 設定例 + +```toml +# ~/.config/starship.toml + +[fossil_metrics] +added_style = 'bold blue' +format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' +``` + ## Google Cloud (`gcloud`) -`gcloud` モジュールは、 [`gcloud`](https://cloud.google.com/sdk/gcloud) CLIの現在の設定が表示されます。 これは `~/.config/gcloud/active_config` ファイルと `~/.config/gcloud/configurations/config_{CONFIG NAME}` ファイルと `CLOUDSDK_CONFIG` 環境変数に基づきます。 +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. When the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active be active when one of the environment variables has been set. ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ---------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 | -| `symbol` | `'☁️ '` | 現在のGCPプロファイルを表示する前に表示される記号です。 | -| `region_aliases` | `{}` | GCP名に加えて表示するリージョンのエイリアスです。 | -| `project_aliases` | `{}` | GCP名に加えて表示するプロジェクトのエイリアスです。 | -| `detect_env_vars` | `[]` | Which environmental variables should trigger this module | -| `style` | `'bold blue'` | モジュールのスタイルです。 | -| `disabled` | `false` | `gcloud`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($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. | +| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | +| `detect_env_vars` | `[]` | Which environmental variables should trigger this module | +| `style` | `'bold blue'` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `gcloud` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ------------- | ----------------------------------------------- | -| region | `us-central1` | 現在のGCPリージョン | -| account | `foo` | 現在のGCPプロファイル | -| domain | `example.com` | 現在のGCPプロファイルのドメイン | -| project | | 現在のGCPプロジェクト | -| active | `default` | `~/.config/gcloud/active_config` に書かれたアクティブな設定名 | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1602,31 +1638,31 @@ very-long-project-name = 'vlpn' ## Git Branch -`git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。 +The `git_branch` module shows the active branch of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `always_show_remote` | `false` | ローカルブランチ名と等しい場合でも、リモート追跡ブランチ名を表示します。 | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | module のフォーマットです。 Use `'$branch'` to refer to the current branch name. | -| `symbol` | `' '` | gitブランチのシンボルを表すフォーマット文字列。 | -| `style` | `'bold purple'` | モジュールのスタイルです。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `'…'` | ブランチ名切り捨てられていることを示すための記号です。 You can use `''` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `ignore_branches` | `[]` | 表示しない名前のリスト。 Useful for 'master' or 'main'. | -| `disabled` | `false` | `git_branch`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `'on [$symbol$branch(:$remote_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 `N` graphemes. | +| `truncation_symbol` | `'…'` | ブランチ名切り捨てられていることを示すための記号です。 You can use `''` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| ------------- | -------- | ---------------------------------------------------------- | -| branch | `master` | 現在のブランチがない場合は、現在のブランチ名は`HEAD`に戻ります(例: git detached `HEAD`) | -| remote_name | `origin` | リモート名 | -| remote_branch | `master` | `remote_name`で追跡されたブランチ名 | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1644,26 +1680,26 @@ ignore_branches = ['master', 'main'] ## Git コミット -`git_commit` モジュールは、カレントディレクトリのリポジトリの現在のコミットハッシュとタグ (もしあれば) を表示します。 +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### オプション | オプション | デフォルト | 説明 | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | 表示される git コミットハッシュの長さ。 | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | module のフォーマットです。 | | `style` | `'bold green'` | モジュールのスタイルです。 | -| `only_detached` | `true` | detached `HEAD` 状態のときのみ git コミットハッシュを表示する | -| `tag_disabled` | `true` | `git_commit` モジュールのタグ情報の表示を無効にする。 | +| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | -| `tag_symbol` | `' 🏷 '` | 表示される情報の前に追加されるタグシンボル | -| `disabled` | `false` | `git_commit` モジュールを無効にします。 | +| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | --------- | -------------------------------------------- | -| hash | `b703eb3` | 現在の git コミットハッシュ | +| hash | `b703eb3` | The current git commit hash | | tag | `v1.0.0` | The tag name if showing tag info is enabled. | | style\* | | オプション `style` の値をミラーする | @@ -1681,31 +1717,31 @@ tag_symbol = '🔖 ' ## Git State -`git_state`モジュールはgitディレクトリの進行状態を表します。 (例: _REBASING_, _BISECTING_, その他) 進行状況の情報がある場合は (例:REBASING 3/10)、その情報も表示されます。 +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'` | `rebase`進行中に表示されるフォーマット文字列です。 | -| `merge` | `'MERGING'` | `merge`進行中に表示されるフォーマット文字列です。 | -| `revert` | `'REVERTING'` | `revert`進行中に表示されるフォーマット文字列です。 | -| `cherry_pick` | `'CHERRY-PICKING'` | `cherry-pick`進行中に表示されるフォーマット文字列です。 | -| `bisect` | `'BISECTING'` | `bisect`進行中に表示されるフォーマット文字列です。 | -| `am` | `'AM'` | `apply-mailbox` (`git am`) 進行中に表示されるフォーマット文字列です。 | -| `am_or_rebase` | `'AM/REBASE'` | あいまいな`apply-mailbox`または`rebase`が進行中のときに表示されるフォーマット文字列です。 | -| `style` | `'bold yellow'` | モジュールのスタイルです。 | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | module のフォーマットです。 | -| `disabled` | `false` | `git_state`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `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. | ### 変数 -| 変数 | 設定例 | 説明 | -| ---------------- | ---------- | ---------------------- | -| state | `REBASING` | 現在のリポジトリの状態 | -| progress_current | `1` | 現在の進行状態 | -| progress_total | `2` | 全体の進行状態 | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| ---------------- | ---------- | ------------------------------ | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1725,7 +1761,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1763,39 +1799,39 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -`git_status` モジュールは、カレントディレクトリのリポジトリの状態を表すシンボルを表示します。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip -WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Statusモジュールは動作が非常に遅いです。 モジュールを無効にするか、`windows_starship`オプションを使用することで、WindowsネイティブのStarshipを使用し、対象の`git_status`を計算できます。 +The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. ::: ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ----------------------------------------------- | ---------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | `git_status` のデフォルトフォーマット | -| `conflicted` | `'='` | このブランチにはマージの競合があります。 | -| `ahead` | `'⇡'` | `ahead`のフォーマット | -| `behind` | `'⇣'` | `behind`のフォーマット | -| `diverged` | `'⇕'` | `diverged`のフォーマット | -| `up_to_date` | `''` | `up_to_date`のフォーマット | -| `untracked` | `'?'` | `untracked`のフォーマット | -| `stashed` | `'$'` | `stashed`のフォーマット | -| `modified` | `'!'` | `modified`のフォーマット | -| `staged` | `'+'` | `staged`のフォーマット | -| `renamed` | `'»'` | `renamed`のフォーマット | -| `deleted` | `'✘'` | `deleted`のフォーマット | -| `typechanged` | `""` | The format of `typechange` | -| `style` | `'bold red'` | モジュールのスタイルです。 | -| `ignore_submodules` | `false` | サブモジュールの変更を無視します。 | -| `disabled` | `false` | `git_status`モジュールを無効にします。 | -| `windows_starship` | | WSLでWindowsディレクトリの`git_status`で使用するWindows Starshipの実行ファイルのLinux上でのパス。 | +| オプション | デフォルト | 説明 | +| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `'='` | This branch has merge conflicts. | +| `ahead` | `'⇡'` | The format of `ahead` | +| `behind` | `'⇣'` | The format of `behind` | +| `diverged` | `'⇕'` | The format of `diverged` | +| `up_to_date` | `''` | The format of `up_to_date` | +| `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` | +| `typechanged` | `""` | The format of `typechange` | +| `style` | `'bold red'` | モジュールのスタイルです。 | +| `ignore_submodules` | `false` | Ignore changes to submodules. | +| `disabled` | `false` | Disables the `git_status` module. | +| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | ### 変数 -` format` 内では以下の変数が利用できます。 +The following variables can be used in `format`: | 変数 | 説明 | | -------------- | ------------------------------------------------------------------------------------------------------------- | @@ -1822,9 +1858,9 @@ The following variables can be used in `diverged`: The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| 変数 | 説明 | -| ------- | ------------- | -| `count` | ファイルの数を表示します。 | +| 変数 | 説明 | +| ------- | ------------------------ | +| `count` | Show the number of files | ### 設定例 @@ -1867,7 +1903,7 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e ## Go -`golang`モジュールは、現在インストールされている[Go](https://golang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `golang` module shows the currently installed version of [Go](https://golang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`go.mod`ファイルが含まれている - カレントディレクトリに`go.sum`ファイルが含まれている @@ -1891,7 +1927,7 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e | `detect_folders` | `['Godeps']` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold cyan'` | モジュールのスタイルです。 | | `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. | -| `disabled` | `false` | `golang`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `golang` module. | ### 変数 @@ -2064,7 +2100,7 @@ format = "via [⌘ $version](bold fg:202) " ## Helm -`helm`モジュールは、現在インストールされている[Helm](https://helm.sh/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`helmfile.yaml`ファイルが含まれている - カレントディレクトリに`Chart.yaml`ファイルが含まれている @@ -2103,18 +2139,18 @@ format = 'via [⎈ $version](bold white) ' ## ホスト名 -`hostname`モジュールには、システムのホスト名が表示されます。 +The `hostname` module shows the system hostname. ### オプション -| オプション | デフォルト | 説明 | -| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 | -| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | -| `trim_at` | `'.'` | この文字が最初にマッチするまでをホスト名と認識します。 `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | module のフォーマットです。 | -| `style` | `'bold dimmed green'` | モジュールのスタイルです。 | -| `disabled` | `false` | `hostname`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to 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` | `'[$ssh_symbol$hostname]($style) in '` | module のフォーマットです。 | +| `style` | `'bold dimmed green'` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `hostname` module. | ### 変数 @@ -2140,7 +2176,7 @@ disabled = false ## Java -`Java`モジュールは、現在インストールされている[Java](https://www.oracle.com/java/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file - カレントディレクトリに拡張子が`.java`、`.class`、`.gradle`、`.jar`、`.clj`または`.cljc`のファイルが含まれている @@ -2156,7 +2192,7 @@ disabled = false | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | モジュールのスタイルです。 | -| `disabled` | `false` | `java`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `java` module. | ### 変数 @@ -2177,9 +2213,9 @@ disabled = false symbol = '🌟 ' ``` -## ジョブ +## Jobs -`jobs`モジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +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 are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -2203,13 +2239,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will | オプション | デフォルト | 説明 | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | 超過した場合、ジョブの数を表示します。 | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `'[$symbol$number]($style) '` | module のフォーマットです。 | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | モジュールのスタイルです。 | -| `disabled` | `false` | `jobs`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -2217,7 +2253,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | 変数 | 設定例 | 説明 | | --------- | --- | ----------------------- | -| number | `1` | ジョブの数 | +| number | `1` | The number of jobs | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2236,7 +2272,7 @@ symbol_threshold = 0 ## Julia -`julia`モジュールは、現在インストールされている[Julia](https://julialang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`Project.toml`ファイルが含まれている - カレントディレクトリに`Manifest.toml`ファイルが含まれている @@ -2251,15 +2287,15 @@ symbol_threshold = 0 | `detect_extensions` | `['jl']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['Project.toml', 'Manifest.toml']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `symbol` | `'ஃ '` | Juliaのシンボルを表すフォーマット文字列 | +| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. | | `style` | `'bold purple'` | モジュールのスタイルです。 | -| `disabled` | `false` | `julia`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `julia` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ----------------------- | -| version | `v1.4.0` | `julia`のバージョン | +| version | `v1.4.0` | The version of `julia` | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2276,29 +2312,29 @@ symbol = '∴ ' ## Kotlin -`kotlin`モジュールは、現在インストールされている[Kotlin](https://kotlinlang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`.kt`もしくは`.kts`ファイルが含まれている ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | -| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `detect_extensions` | `['kt', 'kts']` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `symbol` | `'🅺 '` | Kotlinのシンボルを表すフォーマット文字列 | -| `style` | `'bold blue'` | モジュールのスタイルです。 | -| `kotlin_binary` | `'kotlin'` | Starshipがバージョンを取得するときに実行するkotlinバイナリを設定します。 | -| `disabled` | `false` | `kotlin`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `detect_extensions` | `['kt', 'kts']` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. | +| `style` | `'bold blue'` | モジュールのスタイルです。 | +| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | --------- | ----------------------- | -| version | `v1.4.21` | `kotlin`のバージョン | +| version | `v1.4.21` | The version of `kotlin` | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2323,11 +2359,11 @@ kotlin_binary = 'kotlinc' ## Kubernetes -Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. 環境変数`$KUBECONFIG`が設定されている場合、このモジュールはそれを利用し、`~/.kube/config`を利用しません。 +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2335,28 +2371,50 @@ When the module is enabled it will always be active, unless any of `detect_exten ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ---------------------------------------------------- | --------------------------------- | -| `symbol` | `'☸ '` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | -| `style` | `'cyan bold'` | モジュールのスタイルです。 | -| `context_aliases` | `{}` | コンテキストの表示エイリアスを定義するテーブル。 | -| `user_aliases` | `{}` | Table of user aliases to display. | -| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `true` | `kubernetes` モジュールを無効にする。 | +::: warning + +The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. + +::: + +| オプション | デフォルト | 説明 | +| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | +| `style` | `'cyan bold'` | モジュールのスタイルです。 | +| `context_aliases`* | `{}` | Table of context aliases to display. | +| `user_aliases`* | `{}` | Table of user aliases to display. | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `contexts` | `[]` | Customized styles and symbols for specific contexts. | +| `disabled` | `true` | Disables the `kubernetes` module. | + +*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead. + +To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list: + +| 変数 | 説明 | +| ----------------- | ---------------------------------------------------------------------------------------- | +| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. | +| `user_pattern` | Regular expression to match current Kubernetes user name. | +| `context_alias` | Context alias to display instead of the full context name. | +| `user_alias` | User alias to display instead of the full user name. | +| `style` | The style for the module when using this context. If not set, will use module's style. | +| `symbol` | The symbol for the module when using this context. If not set, will use module's symbol. | + +Note that all regular expression are anchored with `^$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)). ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------------------- | -------------------------------------- | -| context | `starship-context` | The current kubernetes context name | -| namespace | `starship-namespace` | 設定されている場合、現在の Kubernetes の namespace 名 | -| user | `starship-user` | If set, the current kubernetes user | -| cluster | `starship-cluster` | If set, the current kubernetes cluster | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------------------- | ---------------------------------------- | +| context | `starship-context` | The current kubernetes context name | +| namespace | `starship-namespace` | If set, the current kubernetes namespace | +| user | `starship-user` | If set, the current kubernetes user | +| cluster | `starship-cluster` | If set, the current kubernetes cluster | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2368,13 +2426,9 @@ When the module is enabled it will always be active, unless any of `detect_exten [kubernetes] format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' disabled = false -[kubernetes.context_aliases] -'dev.local.cluster.k8s' = 'dev' -'.*/openshift-cluster/.*' = 'openshift' -'gke_.*_(?P[\w-]+)' = 'gke-$var_cluster' -[kubernetes.user_aliases] -'dev.local.cluster.k8s' = 'dev' -'root/.*' = 'root' +contexts = [ + { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " }, +] ``` Only show the module in directories that contain a `k8s` file. @@ -2387,36 +2441,47 @@ disabled = false detect_files = ['k8s'] ``` -#### Regex Matching +#### Kubernetes Context specific config -Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions. - -The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation. - -Long and automatically generated cluster names can be identified and shortened using regular expressions: +The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression. ```toml -[kubernetes.context_aliases] -# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`: -'.*/openshift-cluster/.*' = 'openshift' -# Or better, to rename every OpenShift cluster at once: -'.*/(?P[\w-]+)/.*' = '$var_cluster' +# ~/.config/starship.toml +[[kubernetes.contexts]] +# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user +# equals "admin_user" +context_pattern = "production" +user_pattern = "admin_user" +style = "bold red" +context_alias = "prod" +user_alias = "admin" + +[[kubernetes.contexts]] +# "green" style + a different symbol when Kubernetes current context name contains openshift +context_pattern = ".*openshift.*" +style = "green" +symbol = "💔 " +context_alias = "openshift" + +[[kubernetes.contexts]] +# Using capture groups # Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone. # The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`) # and renames every matching kube context into a more readable format (`gke-cluster-name`): -'gke_.*_(?P[\w-]+)' = 'gke-$var_cluster' +context_pattern = "gke_.*_(?P[\\w-]+)" +context_alias = "gke-$cluster" ``` ## Line Break -`line_break` モジュールは、プロンプトを2行に分割します。 +The `line_break` module separates the prompt into two lines. ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------- | -------------------------------------- | -| `disabled` | `false` | `line_break` モジュールを無効にして、プロンプトを1行にします。 | +| オプション | デフォルト | 説明 | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### 設定例 @@ -2427,25 +2492,25 @@ Long and automatically generated cluster names can be identified and shortened u disabled = true ``` -## ローカルIP +## Local IP -`localip`モジュールは、プライマリネットワークインターフェイスのIPv4アドレスを表示します。 +The `localip` module shows the IPv4 address of the primary network interface. ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------------------------- | ----------------------------------- | -| `ssh_only` | `true` | SSHセッションに接続されている場合にのみ、IPアドレスを表示します。 | -| `format` | `'[$localipv4]($style) '` | module のフォーマットです。 | -| `style` | `'bold yellow'` | モジュールのスタイルです。 | -| `disabled` | `true` | `localip`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ---------- | ------------------------- | ------------------------------------------------------ | +| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | +| `format` | `'[$localipv4]($style) '` | module のフォーマットです。 | +| `style` | `'bold yellow'` | モジュールのスタイルです。 | +| `disabled` | `true` | Disables the `localip` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ------------ | ---------------------- | -| localipv4 | 192.168.1.13 | プライマリIPv4アドレスが含まれています | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ------------ | --------------------------------- | +| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2462,7 +2527,7 @@ disabled = false ## Lua -`lua`モジュールは、現在インストールされている[Lua](http://www.lua.org/) のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`.lua-version`ファイルが含まれている - カレントディレクトリに`lua`ディレクトリが含まれている @@ -2470,23 +2535,23 @@ disabled = false ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | -| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'🌙 '` | Luaのシンボルを表すフォーマット文字列 | -| `detect_extensions` | `['lua']` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `['.lua-version']` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `['lua']` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `'bold blue'` | モジュールのスタイルです。 | -| `lua_binary` | `'lua'` | Starshipがバージョンを取得するときに実行するLuaバイナリを設定します。 | -| `disabled` | `false` | `lua`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. | +| `detect_extensions` | `['lua']` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `['.lua-version']` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `['lua']` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `'bold blue'` | モジュールのスタイルです。 | +| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ----------------------- | -| version | `v5.4.0` | `lua` のバージョン | +| version | `v5.4.0` | The version of `lua` | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2501,27 +2566,27 @@ disabled = false format = 'via [🌕 $version](bold blue) ' ``` -## メモリ使用量 +## Memory Usage -`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 -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------- | ----------------------------------------------- | --------------------------- | -| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | module のフォーマットです。 | -| `symbol` | `'🐏'` | メモリ使用率を表示する前に使用される記号です。 | -| `style` | `'bold dimmed white'` | モジュールのスタイルです。 | -| `disabled` | `true` | `memory_usage`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `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. | ### 変数 @@ -2626,7 +2691,7 @@ truncation_symbol = '' ## Nim -`nim`モジュールは、現在インストールされている[Nim](https://nim-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`nim.cfg`ファイルが含まれている - カレントディレクトリに拡張子が`.nim`のファイルが含まれている @@ -2668,7 +2733,7 @@ symbol = '🎣 ' ## Nix-shell -`nix_shell`モジュールは[nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html)環境を表示します。 このモジュールは、nixシェル環境内にあるときに表示されます。 +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### オプション @@ -2680,7 +2745,7 @@ symbol = '🎣 ' | `impure_msg` | `'impure'` | A format string shown when the shell is impure. | | `pure_msg` | `'pure'` | A format string shown when the shell is pure. | | `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | -| `disabled` | `false` | `nix_shell`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `nix_shell` module. | | `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### 変数 @@ -2709,7 +2774,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -`nodejs`モジュールは、現在インストールされている[Node.js](https://nodejs.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`package.json`ファイルが含まれている - カレントディレクトリに`.node-version`ファイルが含まれている @@ -2729,7 +2794,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | `detect_files` | `['package.json', '.node-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `['node_modules']` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold green'` | モジュールのスタイルです。 | -| `disabled` | `false` | `nodejs`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `nodejs` module. | | `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### 変数 @@ -2754,7 +2819,7 @@ format = 'via [🤖 $version](bold green) ' ## OCaml -`ocaml`モジュールは、現在インストールされている[OCaml](https://ocaml.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに拡張子`.opam`のファイルまたは`_opam`ディレクトリが含まれている - カレントディレクトリに`esy.lock`ディレクトリが含まれている @@ -2882,7 +2947,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2972,9 +3037,9 @@ Windows = " " Arch = "Arch is the best! " ``` -## パッケージのバージョン +## Package Version -`package` モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2998,14 +3063,14 @@ Arch = "Arch is the best! " ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | --------------------------------- | --------------------------------------------------------- | -| `format` | `'is [$symbol$version]($style) '` | module のフォーマットです。 | -| `symbol` | `'📦 '` | パッケージのバージョンを表示する前に使用される記号です。 | -| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `style` | `'bold 208'` | モジュールのスタイルです。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | `package` モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------------- | --------------------------------- | ---------------------------------------------------------- | +| `format` | `'is [$symbol$version]($style) '` | module のフォーマットです。 | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `style` | `'bold 208'` | モジュールのスタイルです。 | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### 変数 @@ -3028,7 +3093,7 @@ format = 'via [🎁 $version](208 bold) ' ## Perl -`perl`モジュールは、現在インストールされている[Perl](https://www.perl.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`Makefile.PL`または`Build.PL`ファイルが含まれている - カレントディレクトリに`cpanfile`または`cpanfile.snapshot`ファイルが含まれている @@ -3068,7 +3133,7 @@ format = 'via [🦪 $version]($style) ' ## PHP -`php`モジュールは、現在インストールされている[PHP](https://www.php.net/) のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `php` module shows the currently installed version of [PHP](https://www.php.net/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`composer.json`ファイルが含まれている - カレントディレクトリに`.php-version`ファイルが含まれている @@ -3080,12 +3145,12 @@ format = 'via [🦪 $version]($style) ' | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'🐘 '` | PHPのバージョンを表示する前に使用される記号です。 | +| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `['php']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['composer.json', '.php-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'147 bold'` | モジュールのスタイルです。 | -| `disabled` | `false` | `php`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `php` module. | ### 変数 @@ -3127,7 +3192,7 @@ The `pulumi` module shows the current username, selected [Pulumi Stack](https:// ::: tip -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). それでも有効にしたい場合は、 [以下の例に従ってください](#with-pulumi-version). +By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). ::: @@ -3181,7 +3246,7 @@ format = '[$symbol$stack]($style) ' ## PureScript -`purescript`モジュールは、現在インストールされている[PureScript](https://www.purescript.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`spago.dhall`ファイルが含まれている - カレントディレクトリに拡張子が`.purs`のファイルが含まれている @@ -3222,7 +3287,7 @@ format = 'via [$symbol$version](bold white)' The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -`pyenvversionname` が `true` に設定されている場合 、pyenv でのバージョン名が表示されます 。 そうでなければ、`python --version` を元にバージョン番号を表示します。 +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`. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 @@ -3244,13 +3309,13 @@ The `python` module shows the currently installed version of [Python](https://ww | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | モジュールのスタイルです。 | -| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `['py']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `false` | `python`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `python` module. | ::: tip @@ -3309,7 +3374,7 @@ python_binary = ['./venv/bin/python', 'python', 'python3', 'python2'] ## R -`rlang`モジュールは、現在インストールされている[R](https://www.r-project.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに拡張子が`.R`のファイルが含まれている - カレントディレクトリに拡張子が`.Rd`のファイルが含まれている @@ -3389,7 +3454,7 @@ format = 'via [🦪 $version]($style) ' ## Red -デフォルトでは`red`モジュールは、現在インストールされている[Red](https://www.red-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに拡張子が`.red` or `.reds`のファイルが含まれている @@ -3427,7 +3492,7 @@ symbol = '🔴 ' ## Ruby -デフォルトでは`ruby`モジュールは現在インストールされている[Ruby](https://www.ruby-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに`Gemfile`ファイルが含まれている - カレントディレクトリに `.ruby-version` ファイルが含まれている @@ -3442,13 +3507,13 @@ Starship gets the current Ruby version by running `ruby -v`. | ------------------- | ------------------------------------ | ------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'💎 '` | Rubyのシンボルを表すフォーマット文字列. | +| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. | | `detect_extensions` | `['rb']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['Gemfile', '.ruby-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | モジュールのスタイルです。 | -| `disabled` | `false` | `ruby`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `ruby` module. | ### 変数 @@ -3471,7 +3536,7 @@ symbol = '🔺 ' ## Rust -デフォルトでは`rust`モジュールは現在インストールされている[Rust](https://www.rust-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに`Cargo.toml`ファイルが含まれている - カレントディレクトリに`.rs`の拡張子のファイルが含まれている @@ -3482,18 +3547,18 @@ symbol = '🔺 ' | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'🦀 '` | Rustのシンボルを表すフォーマット文字列 | +| `symbol` | `'🦀 '` | A format string representing the symbol of Rust | | `detect_extensions` | `['rs']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['Cargo.toml']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold red'` | モジュールのスタイルです。 | -| `disabled` | `false` | `rust`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `rust` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ----------------- | -------------------------------------------- | -| version | `v1.43.0-nightly` | `rustc`のバージョン | +| version | `v1.43.0-nightly` | The version of `rustc` | | numver | `1.51.0` | The numeric component of the `rustc` version | | toolchain | `beta` | The toolchain version | | symbol | | オプション `symbol` の値をミラーする | @@ -3512,7 +3577,7 @@ format = 'via [⚙️ $version](red bold)' ## Scala -`scala` モジュールは、現在インストールされている[Scala](https://www.scala-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`build.sbt`、`.scalaenv`または`.sbtenv`ファイルが含まれている - カレントディレクトリに拡張子が`.scala`または`.sbt`のファイルが含まれている @@ -3556,7 +3621,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3584,7 +3649,7 @@ The `shell` module shows an indicator for currently used shell. | 変数 | デフォルト | 説明 | | --------- | ----- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | オプション `style` の値をミラーする. | +| style\* | | Mirrors the value of option `style`. | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3761,7 +3826,7 @@ The `status` module displays the exit code of the previous command. If $success_ ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3822,7 +3887,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3867,7 +3932,7 @@ disabled = false ## Swift -デフォルトでは`swift` モジュールは、現在インストールされている[Swift](https://swift.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに`Package.swift`ファイルが含まれている - カレントディレクトリに拡張子が`.swift`のファイルが含まれている @@ -3906,11 +3971,11 @@ format = 'via [🏎 $version](red bold)' ## Terraform -`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: tip -Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version). +By default the Terraform version is not shown, since this is slow for 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-terraform-version). ::: @@ -3925,21 +3990,21 @@ Terraformのバージョンはデフォルトでは表示されません。多 | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `'via [$symbol$workspace]($style) '` | モジュールのフォーマット文字列。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'💠'` | ワークスペースの前に表示されるフォーマット文字列。 | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | | `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `['.terraform']` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold 105'` | モジュールのスタイルです。 | -| `disabled` | `false` | `terraform` モジュールを無効にします。 | +| `disabled` | `false` | Disables the `terraform` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ---------- | ----------------------- | -| version | `v0.12.24` | `terraform` のバージョン | -| workspace | `default` | 現在のTerraformワークスペース | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ---------- | ------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3965,25 +4030,25 @@ format = '[🏎💨 $workspace]($style) ' ## 時刻 -`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 +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` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | モジュールのフォーマット文字列。 | -| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 | -| `time_format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | -| `style` | `'bold yellow'` | モジュールのスタイルです。 | -| `utc_time_offset` | `'local'` | 使用するUTCオフセットを設定します。 Range from -24 < x < 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。 | -| `disabled` | `true` | `time`モジュールを無効にします。 | -| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| オプション | デフォルト | 説明 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | モジュールのフォーマット文字列。 | +| `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. @@ -4009,9 +4074,9 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` -## ユーザー名 +## Username -`username`モジュールはアクティブなユーザーのユーザー名を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - カレントユーザーが、ログインしているユーザーとは異なる @@ -4029,10 +4094,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` | オプション | デフォルト | 説明 | | ------------- | ----------------------- | ------------------------------------------- | | `style_root` | `'bold red'` | The style used when the user is root/admin. | -| `style_user` | `'bold yellow'` | 非rootユーザーに使用されるスタイルです。 | +| `style_user` | `'bold yellow'` | The style used for non-root users. | | `format` | `'[$user]($style) in '` | module のフォーマットです。 | -| `show_always` | `false` | `username` モジュールを常に表示します。 | -| `disabled` | `false` | `username` モジュールを無効にします。 | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### 変数 @@ -4056,7 +4121,7 @@ show_always = true ## Vagrant -`vagrant`モジュールは、現在インストールされている[Vagrant](https://www.vagrantup.com/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`Vagrantfile`ファイルが含まれている @@ -4094,7 +4159,7 @@ format = 'via [⍱ $version](bold white) ' ## V -`vlang`モジュールは、現在インストールされている[V](https://vlang.io/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに拡張子が`.v`のファイルが含まれている - カレントディレクトリに`v.mod`、`vpkg.json`または`.vpkg-lock.json`ファイルが含まれている @@ -4162,7 +4227,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに拡張子が`.zig`のファイルが含まれている @@ -4243,8 +4308,8 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | -| `shell` | | [この表の下を参照してください](#custom-command-shell) | -| `説明` | `''` | The description of the module that is shown when running `starship explain`. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |